Re: [R-pkg-devel] using @inheritParams in documenting data
Hi Dirk - thank you for your kind mail - I can see I better follow the basic
ways! Also since I seem by my shortcuts to have accomplished a major
problem: I had two *.RData files with similar variables of same names in
/data - if I included both and had no rda files to document data, I had this
previously mentioned problem of "following objects are masked by "glovalEnv"
- but if I used the rda files on data directly from RStudio the data were
kept to be from only one of the RData files, I think the first one -
load("*.RData") of course was still correct.
Thanks a lot for your patience
Troels
-Oprindelig meddelelse-
Fra: Dirk Eddelbuettel På vegne af Dirk
Eddelbuettel
Sendt: 12. januar 2019 13:45
Til: Troels Ring
Cc: package-develop
Emne: Re: [R-pkg-devel] using @inheritParams in documenting data
Hi Troels,
Always good to see someone work on packaging with so much energy.
On 12 January 2019 at 08:46, Troels Ring wrote:
| BUT where and how to put the @inheritParams CMB I cannot find documented.
| Otherwise it seems to run OK
I fear you are getting confused between 'roxygen2' and base R.
'roxygen2' is a very handy and powerful add-on package extending R. But none
of its variables, (which conveniently all start with a @) will be documented
in the proper manual, Writing R Extension.
You question about \describe, however, is about Rd which is base R. And that
very command is 'shadowed' by roxygen2 which generates that section. That is
not unlike your previous question about exporting / registration.
Personally, I see value in working old-school here, and continue to argue
that one should be familiar with the _basic_ and _portable_ commands in
Writing R Extensions before putting another layer on top. Just how I find
it helps to explain what Rcpp does if one has a mental image of the
underlying 'SEXP .Call(funcname, SEXP, SEXP)' it is working with. So I do
use roxygen to create Rd files but I also spent a decade or so writing Rd
files -- and quite a few people (hi, Duncan) still recommend doing it by
hand. I think it helps. And you can mix and match.
Also, a decent trick is to search on GitHub with 'user:cran' to restrict
your search to the mirror (thanks, Gabor!) of CRAN packages. For just about
any question, it quite likely that there will be someone who has been there
before among the now (almost) 13,700 packages out there.
Dirk
--
http://dirk.eddelbuettel.com | @eddelbuettel | e...@debian.org
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [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
Sendt: 12. januar 2019 14:28
Til: Troels Ring
Cc: package-develop
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
On Sat, 12 Jan 2019 at 08:46, Troels Ring mailto:tr...@gvdnet.dk> > wrote:
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
[[alternative HTML version deleted]]
__
R-package-devel@r-project.org <mailto:R-package-devel@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]]
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel
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
On Sat, 12 Jan 2019 at 08:46, Troels Ring wrote:
> 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
>
>
> [[alternative HTML version deleted]]
>
> __
> R-package-devel@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]]
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel
Re: [R-pkg-devel] using @inheritParams in documenting data
Hi Troels, Always good to see someone work on packaging with so much energy. On 12 January 2019 at 08:46, Troels Ring wrote: | BUT where and how to put the @inheritParams CMB I cannot find documented. | Otherwise it seems to run OK I fear you are getting confused between 'roxygen2' and base R. 'roxygen2' is a very handy and powerful add-on package extending R. But none of its variables, (which conveniently all start with a @) will be documented in the proper manual, Writing R Extension. You question about \describe, however, is about Rd which is base R. And that very command is 'shadowed' by roxygen2 which generates that section. That is not unlike your previous question about exporting / registration. Personally, I see value in working old-school here, and continue to argue that one should be familiar with the _basic_ and _portable_ commands in Writing R Extensions before putting another layer on top. Just how I find it helps to explain what Rcpp does if one has a mental image of the underlying 'SEXP .Call(funcname, SEXP, SEXP)' it is working with. So I do use roxygen to create Rd files but I also spent a decade or so writing Rd files -- and quite a few people (hi, Duncan) still recommend doing it by hand. I think it helps. And you can mix and match. Also, a decent trick is to search on GitHub with 'user:cran' to restrict your search to the mirror (thanks, Gabor!) of CRAN packages. For just about any question, it quite likely that there will be someone who has been there before among the now (almost) 13,700 packages out there. Dirk -- http://dirk.eddelbuettel.com | @eddelbuettel | e...@debian.org __ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
[R-pkg-devel] using @inheritParams in documenting data
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
[[alternative HTML version deleted]]
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel
