[R-pkg-devel] How to build *-package description from *-package.R files ... and a luser/newbie question about pkgdown

Merlise Clyde, Ph.D. c|yde @end|ng |rom duke@edu
Fri Feb 12 17:34:21 CET 2021


I have migrated from Travis CI to using GitHub actions with pkgdown to build websites for packages - see https://ropenscilabs.github.io/actions_sandbox/websites-using-pkgdown-bookdown-and-blogdown.html   to set up.  The GitHub action doesn’t use Rstudio’s check but does automatically update the documentation when the master branch is pushed to GitHub.

An example is at https://merliseclyde.github.io/BAS/index.html. (package is at  https://github.com/merliseclyde/BAS  ).  One that is a work in progress is https://merliseclyde.github.io/bark - which was built from the start using the approach documented above  - there is less customization there.

I do use pkgdown::build_site() in RStudio to preview the package documentation locally as well.

For documentation I did migrate to using roxygen2 several years ago from writing my own Rd files.   I like the checks that it keeps the documentation in sync with changes in the function.   The R Packages book by Hadley Wickham and Jennifer Bryan has a nice chapter on this https://r-pkgs.org/man.html


On Feb 12, 2021, at 10:52 AM, Chris Evans <chrishold using psyctc.org<mailto:chrishold using psyctc.org>> wrote:

Apologies, I think that was clear.

Do you or anyone else have an example of a ****-package.R that Rstudio's check has built into a package documentation file that was well populated and useful?

I think that's the key exemplar I am seeking and I'm finding it hard to craft any web search that finds me such a thing.

Any offer?!  TIA,


----- Original Message -----
From: "Duncan Murdoch" <murdoch.duncan using gmail.com<mailto:murdoch.duncan using gmail.com>>
To: "Chris Evans" <chrishold using psyctc.org<mailto:chrishold using psyctc.org>>
Cc: "r-package-devel" <r-package-devel using r-project.org<mailto:r-package-devel using r-project.org>>
Sent: Friday, 12 February, 2021 15:40:25
Subject: Re: [R-pkg-devel] How to build *-package description from *-package.R files ... and a luser/newbie question
about pkgdown

Just one clarification:

On 12/02/2021 9:59 a.m., Chris Evans wrote:
[ lots deleted ]

 - I don't think RStudio supports a "Preview" for the help page for a
function (but I might be wrong about this, since I don't use it much).

I haven't found it if it is there.  I'm guessing you use ESS?

No, I use RStudio.  When I said "I don't use it much", I meant Roxygen2.

Duncan Murdoch

Small contribution in our coronavirus rigours:

Chris Evans <chris using psyctc.org<mailto:chris using psyctc.org>> Visiting Professor, University of Sheffield <chris.evans using sheffield.ac.uk<mailto:chris.evans using sheffield.ac.uk>>
I do some consultation work for the University of Roehampton <chris.evans using roehampton.ac.uk<mailto:chris.evans using roehampton.ac.uk>> and other places
but <chris using psyctc.org<mailto:chris using psyctc.org>> remains my main Email address.  I have a work web site at:
and a site I manage for CORE and CORE system trust at:
I have "semigrated" to France, see:

If you want an Emeeting, I am trying to keep them to Thursdays and my diary is at:
Beware: French time, generally an hour ahead of UK.

R-package-devel using r-project.org<mailto:R-package-devel using r-project.org> mailing list

	[[alternative HTML version deleted]]

More information about the R-package-devel mailing list