Re: [Rd] Best practices in developing package: From a single file

On Thu, Feb 1, 2018 at 9:20 AM, Gabriel Becker wrote: > On Thu, Feb 1, 2018 at 5:24 AM, Lionel Henry wrote: > > > On 31 janv. 2018, at 09:08, Gabriel Becker wrote: > > > > > it *actively discourages* the bits it doesn't directly

Re: [Rd] Best practices in developing package: From a single file

On 01/02/2018 12:20 PM, Gabriel Becker wrote: [ lots deleted...] Or perhaps you could imagine two help systems, akin to --help and man for command line tools, one of which is minimalist showing usage, etc, generated by roxygen comments, and one of which is much more extensive, and not tied to

Re: [Rd] Best practices in developing package: From a single file

On Thu, Feb 1, 2018 at 6:20 PM, Gabriel Becker wrote: > > Or perhaps you could imagine two help systems, akin to --help and man for > command line tools, one of which is minimalist showing usage, etc, > generated by roxygen comments, and one of which is much more extensive,

Re: [Rd] Best practices in developing package: From a single file

On Thu, Feb 1, 2018 at 5:24 AM, Lionel Henry wrote: > On 31 janv. 2018, at 09:08, Gabriel Becker wrote: > > > it *actively discourages* the bits it doesn't directly support. > > It may be discouraging to include Rd syntax in roxygen docs but only >

Re: [Rd] Best practices in developing package: From a single file

On Thu, Feb 1, 2018 at 4:29 AM, Duncan Murdoch wrote: > On 31/01/2018 6:59 AM, Duncan Murdoch wrote: >> >> On 30/01/2018 11:39 PM, Hadley Wickham wrote: > > [ lots deleted ] >>> >>> Personally, I don't find writing in comments any harder than writing >>> in .Rd files,

Re: [Rd] Best practices in developing package: From a single file

On 01/02/2018 7:44 AM, Joris Meys wrote: On Thu, Feb 1, 2018 at 1:29 PM, Duncan Murdoch > wrote: On 31/01/2018 6:59 AM, Duncan Murdoch wrote: On 30/01/2018 11:39 PM, Hadley Wickham wrote:  [ lots deleted ]

Re: [Rd] Best practices in developing package: From a single file

On 01/02/2018 8:17 AM, Georgi Boshnakov wrote: It is indeed a matter of what the developer is comfortable with and the one-stop solution provided by devtools is difficult to beat. This may also vary across projects. I use EMACS/ESS with and without roxygen2. In some cases EMACS/ESS+Org mode

Re: [Rd] Best practices in developing package: From a single file

On 31 janv. 2018, at 09:08, Gabriel Becker wrote: > it *actively discourages* the bits it doesn't directly support. It may be discouraging to include Rd syntax in roxygen docs but only because the LaTeX-like syntax of Rd is burdensome, not because of roxygen. It is still

Re: [Rd] Best practices in developing package: From a single file

och <murdoch.dun...@gmail.com> Cc: "Brian G. Peterson" <br...@braverock.com>, "Suzen, Mehmet" <mehmet.su...@gmail.com>, R-devel <r-devel@r-project.org> Subject: Re: [Rd] Best practices in developing package: From a single file Message-I

Re: [Rd] Best practices in developing package: From a single file

On Thu, Feb 1, 2018 at 1:29 PM, Duncan Murdoch wrote: > On 31/01/2018 6:59 AM, Duncan Murdoch wrote: > >> On 30/01/2018 11:39 PM, Hadley Wickham wrote: >> > [ lots deleted ] > >> Personally, I don't find writing in comments any harder than writing >>> in .Rd files,

Re: [Rd] Best practices in developing package: From a single file

On 31/01/2018 6:59 AM, Duncan Murdoch wrote: On 30/01/2018 11:39 PM, Hadley Wickham wrote: [ lots deleted ] Personally, I don't find writing in comments any harder than writing in .Rd files, especially now that you can write in markdown and have it automatically translated to Rd formatting

Re: [Rd] Best practices in developing package: From a single file

On 31/01/2018 8:59 AM, Mark van der Loo wrote: I fully agree with Joris and Hadley on roxygen2. Additionally: I wrote and published my first package before roxygen (or roxygen2) was available. I found editing .Rd extremely terse (especially when code is updated). For example, the fact that

Re: [Rd] Best practices in developing package: From a single file

rd > > > > ps: incidentally, within the noweb-file roxygen is employed. > > > > -Ursprüngliche Nachricht- > > Von: R-devel [mailto:r-devel-boun...@r-project.org] Im Auftrag von > Joris Meys > > Gesendet: Mittwoch, 31. Januar 2018 14:02 > &

Re: [Rd] Best practices in developing package: From a single file

rg] Im Auftrag von Joris Meys > Gesendet: Mittwoch, 31. Januar 2018 14:02 > An: Duncan Murdoch > Cc: r-devel > Betreff: [EXT] Re: [Rd] Best practices in developing package: From a single > file > > On Wed, Jan 31, 2018 at 1:41 PM, Duncan Murdoch <murdoch.dun...@gmail.com> > wr

Re: [Rd] Best practices in developing package: From a single file

I pretty much agree. I tried using roxygen when it was first released but couldn't stand putting documentation in comments, especially for complex, S4-based software. Rd is easy to read and write and lets me focus on the task of writing documentation (focus is the hardest part of any task for me).

Re: [Rd] Best practices in developing package: From a single file

> > ps: incidentally, within the noweb-file roxygen is employed. > > -Ursprüngliche Nachricht- > Von: R-devel [mailto:r-devel-boun...@r-project.org] Im Auftrag von Joris Meys > Gesendet: Mittwoch, 31. Januar 2018 14:02 > An: Duncan Murdoch > Cc: r-devel > Betreff: [EXT]

Re: [Rd] Best practices in developing package: From a single file

. -Ursprüngliche Nachricht- Von: R-devel [mailto:r-devel-boun...@r-project.org] Im Auftrag von Joris Meys Gesendet: Mittwoch, 31. Januar 2018 14:02 An: Duncan Murdoch Cc: r-devel Betreff: [EXT] Re: [Rd] Best practices in developing package: From a single file On Wed, Jan 31, 2018 at 1:41 PM, Duncan

Re: [Rd] Best practices in developing package: From a single file

I fully agree with Joris and Hadley on roxygen2. Additionally: I wrote and published my first package before roxygen (or roxygen2) was available. I found editing .Rd extremely terse (especially when code is updated). For example, the fact that there are no spaces allowed between } and { in

Re: [Rd] Best practices in developing package: From a single file

On Wed, Jan 31, 2018 at 1:41 PM, Duncan Murdoch wrote: > On 31/01/2018 6:33 AM, Joris Meys wrote: > > 3. given your criticism, I'd like your opinion on where I can improve the >> documentation of https://github.com/CenterForStatistics-UGent/pim. I'm >> currently busy

Re: [Rd] Best practices in developing package: From a single file

(Please do not quote without attribution) On 30 January 2018 at 20:44, Hadley Wickham wrote: | Personally, I think the biggest problem with package.skeleton() is | that it assumes that the source of truth is objects in an environment. | This seems the wrong way around to me. Basically

Re: [Rd] Best practices in developing package: From a single file

On 31/01/2018 6:33 AM, Joris Meys wrote: 3. given your criticism, I'd like your opinion on where I can improve the documentation of https://github.com/CenterForStatistics-UGent/pim. I'm currently busy updating the help files for a next release on CRAN, so your input is more than welcome.

Re: [Rd] Best practices in developing package: From a single file

On 31/01/2018 6:33 AM, Joris Meys wrote: Dear Duncan, With all respect, but I strongly disagree on your stance regarding roxygen2 for multiple reasons: 1. It is in my humble opinion not correct to evaluate a tool based on the abuse of some users. It's not because people write packages with

Re: [Rd] Best practices in developing package: From a single file

On 30/01/2018 11:39 PM, Hadley Wickham wrote: On Tue, Jan 30, 2018 at 4:55 PM, Duncan Murdoch wrote: On 30/01/2018 4:30 PM, Kenny Bell wrote: In response to Duncan regarding the use of roxygen2 from the point of view of a current user, I believe the issue he brings

Re: [Rd] Best practices in developing package: From a single file

Dear Duncan, With all respect, but I strongly disagree on your stance regarding roxygen2 for multiple reasons: 1. It is in my humble opinion not correct to evaluate a tool based on the abuse of some users. It's not because people write packages with bad documentation, that roxygen2 is to blame.

Re: [Rd] Best practices in developing package: From a single file

>> There is package.skeleton() in base R as you already mentioned. It drove >> me >> bonkers that it creates packages which then fail R CMD check, so I wrote a >> wrapper package (pkgKitten) with another helper function (kitten()) which >> calls the base R helper and then cleans up it---but

Re: [Rd] Best practices in developing package: From a single file

On Tue, Jan 30, 2018 at 4:55 PM, Duncan Murdoch wrote: > On 30/01/2018 4:30 PM, Kenny Bell wrote: >> >> In response to Duncan regarding the use of roxygen2 from the point of view >> of a current user, I believe the issue he brings up is one of correlation >> rather than

Re: [Rd] Best practices in developing package: From a single file

On 30/01/2018 4:12 PM, Dirk Eddelbuettel wrote: Mehmet, That is a loaded topic, not unlikely other topics preoccupying us these days. There is package.skeleton() in base R as you already mentioned. It drove me bonkers that it creates packages which then fail R CMD check, so I wrote a wrapper

Re: [Rd] Best practices in developing package: From a single file

On 30/01/2018 4:30 PM, Kenny Bell wrote: In response to Duncan regarding the use of roxygen2 from the point of view of a current user, I believe the issue he brings up is one of correlation rather than causation. Could be. However, I think editing comments in a .R file is a bit harder than

Re: [Rd] Best practices in developing package: From a single file

On 30 January 2018 at 21:31, Cook, Malcolm wrote: > > I think you want to see the approach to generating a skeleton from a single > .R file presented in: > > Simple and sustainable R packaging using inlinedocs > http://inlinedocs.r-forge.r-project.org/ > > I have not

Re: [Rd] Best practices in developing package: From a single file

Dear All, Thank you for all valuable input and sorry for the off-topic for the list. I will try R-pkg-devel for further related questions. I was actually after "one-go" auto-documentation in-line or out of comments from a single file/environment in a similar spirit to 'package.skeleton or an

Re: [Rd] Best practices in developing package: From a single file

In response to Duncan regarding the use of roxygen2 from the point of view of a current user, I believe the issue he brings up is one of correlation rather than causation. Writing my first piece of R documentation was made much easier by using roxygen2, and it shallowed the learning curve

Re: [Rd] Best practices in developing package: From a single file

Mehmet, That is a loaded topic, not unlikely other topics preoccupying us these days. There is package.skeleton() in base R as you already mentioned. It drove me bonkers that it creates packages which then fail R CMD check, so I wrote a wrapper package (pkgKitten) with another helper function

Re: [Rd] Best practices in developing package: From a single file

On 30/01/2018 11:29 AM, Brian G. Peterson wrote: On Tue, 2018-01-30 at 17:00 +0100, Suzen, Mehmet wrote: Dear R developers, I am wondering what are the best practices for developing an R package. I am aware of Hadley Wickham's best practice documentation/book (http://r-pkgs.had.co.nz/).  I

Re: [Rd] Best practices in developing package: From a single file

On Tue, 2018-01-30 at 17:00 +0100, Suzen, Mehmet wrote: > Dear R developers, > > I am wondering what are the best practices for developing an R > package. I am aware of Hadley Wickham's best practice > documentation/book (http://r-pkgs.had.co.nz/).  I recall a couple of > years ago there were

[Rd] Best practices in developing package: From a single file

Dear R developers, I am wondering what are the best practices for developing an R package. I am aware of Hadley Wickham's best practice documentation/book (http://r-pkgs.had.co.nz/). I recall a couple of years ago there were some tools for generating a package out of a single file, such as using