Duncan Murdoch
2018-Jan-31 12:41 UTC
[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.After this invitation I sent some private comments to Joris. I would say his package does a pretty good job of documentation; it isn't the kind of Roxygen-using package that I was complaining about. So I will say I have received an example of a Roxygen-using package that has good help pages. Duncan Murdoch
Joris Meys
2018-Jan-31 13:01 UTC
[Rd] Best practices in developing package: From a single file
On Wed, Jan 31, 2018 at 1:41 PM, Duncan Murdoch <murdoch.duncan at gmail.com> 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 updating the help files for a next release on CRAN, so your >> input is more than welcome. >> > > After this invitation I sent some private comments to Joris. I would say > his package does a pretty good job of documentation; it isn't the kind of > Roxygen-using package that I was complaining about. So I will say I have > received an example of a Roxygen-using package that > has good help pages. >Thank you for the nice compliment and the valuable tips. -- Joris Meys Statistical consultant Department of Data Analysis and Mathematical Modelling Ghent University Coupure Links 653, B-9000 Gent (Belgium) <https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g> ----------- Biowiskundedagen 2017-2018 http://www.biowiskundedagen.ugent.be/ ------------------------------- Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php [[alternative HTML version deleted]]
Mark van der Loo
2018-Jan-31 13:59 UTC
[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 \param{}{} has hurt my brain quite a few times, especially since R CMD check did not give any useful error messages about it. For me it is a signal that the Rd parser is rather primitive. On the other hand Roxygen2 now usually gives pretty good error messages when I syntax error something. Also, the 'parent' of roxygen is Doxygen, which was already widely used (also by me) in the C/C++ community before roxygen was published. I cannot remember anyone ever complaining about C/C++ documentation deteriorating because of Doxygen. -Mark Op wo 31 jan. 2018 om 14:02 schreef Joris Meys <jorismeys at gmail.com>:> On Wed, Jan 31, 2018 at 1:41 PM, Duncan Murdoch <murdoch.duncan at gmail.com> > 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 updating the help files for a next release on CRAN, so > your > >> input is more than welcome. > >> > > > > After this invitation I sent some private comments to Joris. I would say > > his package does a pretty good job of documentation; it isn't the kind of > > Roxygen-using package that I was complaining about. So I will say I have > > received an example of a Roxygen-using package that > > has good help pages. > > > > Thank you for the nice compliment and the valuable tips. > > -- > Joris Meys > Statistical consultant > > Department of Data Analysis and Mathematical Modelling > Ghent University > Coupure Links 653, B-9000 Gent (Belgium) > < > https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g > > > > ----------- > Biowiskundedagen 2017-2018 > http://www.biowiskundedagen.ugent.be/ > > ------------------------------- > Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php > > [[alternative HTML version deleted]] > > ______________________________________________ > R-devel at r-project.org mailing list > https://stat.ethz.ch/mailman/listinfo/r-devel >[[alternative HTML version deleted]]
Pfaff, Bernhard Dr.
2018-Jan-31 14:51 UTC
[Rd] Best practices in developing package: From a single file
Dear All: stepping in late, but @Joris, if you would like to take 'from a single file' literally, have a look at: https://github.com/bpfaff/lp4rp (lp4rp: literate programming for R packages); Cheers, Bernhard ps: incidentally, within the noweb-file roxygen is employed. -----Urspr?ngliche Nachricht----- Von: R-devel [mailto:r-devel-bounces at 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 Murdoch <murdoch.duncan at gmail.com> 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 updating the help files for a next release on >> CRAN, so your input is more than welcome. >> > > After this invitation I sent some private comments to Joris. I would > say his package does a pretty good job of documentation; it isn't the > kind of Roxygen-using package that I was complaining about. So I will > say I have received an example of a Roxygen-using package that has > good help pages. >Thank you for the nice compliment and the valuable tips. -- Joris Meys Statistical consultant Department of Data Analysis and Mathematical Modelling Ghent University Coupure Links 653, B-9000 Gent (Belgium) <https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g> ----------- Biowiskundedagen 2017-2018 http://www.biowiskundedagen.ugent.be/ ------------------------------- Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php [[alternative HTML version deleted]] ______________________________________________ R-devel at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel ***************************************************************** Confidentiality Note: The information contained in this ...{{dropped:10}}
Reasonably Related Threads
- Best practices in developing package: From a single file
- Best practices in developing package: From a single file
- Best practices in developing package: From a single file
- Best practices in developing package: From a single file
- Best practices in developing package: From a single file