[R-pkg-devel] using @inheritParams in documenting data

Thanks a lot! I stumbled over the RStudio way of producing *.rda files for data sets individually instead of making a *.R file as Hadley writes in the book if I understand it correctly. 

It certainly is fun to find out about !!

All best wishes

Troels

 

Fra: Alexandre Courtiol <alexandre.courtiol at gmail.com> 
Sendt: 12. januar 2019 14:28
Til: Troels Ring <tring at gvdnet.dk>
Cc: package-develop <r-package-devel at r-project.org>
Emne: Re: [R-pkg-devel] using @inheritParams in documenting data

 

Hi Troels,

If you want to create a R package (using roxygen2), I would highly recommend you to read Hadley Wickham's book on the topic.

The book is easy, short, practical and legally free (here: http://r-pkgs.had.co.nz/).

If you follow it step by step, everything should work fine.

For anything not covered by the book, as Dirk said, look for examples of packages you know in GitHub.

++

Alex

Dearfriends , with your help I'm rapidly improving package development. When
documenting data, I seem to be helped mpst by making the rda directly from
RStudio via file, new file, R documentation then choosing data. However, my
data files have a lot of params, so I thought I might use @inheritParams
since these params are already documented elsewhere in the package. Hence,
in the rda file created directly from RStudio I tried to add @inheritParams
CMB (since the params are already documented in CMB) but I cannot find
exactly how to put it in the rda file.

The skeleton has

\describe{

                           \item{\code(x)}{vector}

And if I put some the params in a comma separated row instead of x they are
acknowledged in the final rda file -

BUT where and how to put the @inheritParams CMB I cannot find documented.
Otherwise it seems to run OK



All best wishes

Troels



______________________________________________
R-package-devel at r-project.org <mailto:R-package-devel at r-project.org>  mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Alexandre Courtiol

http://sites.google.com/site/alexandrecourtiol/home

"Science is the belief in the ignorance of experts", R. Feynman


	[[alternative HTML version deleted]]