Please note that most rooygen2 users don't call the overview file 'pkgname-package' but just 'pkgname'. Also, these days people mostly use README.md for approximately that purpose and put a very minimal statement in pkgname-package or equivalent.
Georgi Boshnakov -----Original Message----- From: R-package-devel <[email protected]> On Behalf Of Chris Evans Sent: 12 February 2021 15:52 To: Duncan Murdoch <[email protected]> Cc: r-package-devel <[email protected]> Subject: Re: [R-pkg-devel] How to build *-package description from *-package.R files ... and a luser/newbie question about pkgdown 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, Chris ----- Original Message ----- > From: "Duncan Murdoch" <[email protected]> > To: "Chris Evans" <[email protected]> > Cc: "r-package-devel" <[email protected]> > 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: https://www.coresystemtrust.org.uk/home/free-options-to-replace-paper-core-forms-during-the-coronavirus-pandemic/ Chris Evans <[email protected]> Visiting Professor, University of Sheffield <[email protected]> I do some consultation work for the University of Roehampton <[email protected]> and other places but <[email protected]> remains my main Email address. I have a work web site at: https://www.psyctc.org/psyctc/ and a site I manage for CORE and CORE system trust at: http://www.coresystemtrust.org.uk/ I have "semigrated" to France, see: https://www.psyctc.org/pelerinage2016/semigrating-to-france/ https://www.psyctc.org/pelerinage2016/register-to-get-updates-from-pelerinage2016/ If you want an Emeeting, I am trying to keep them to Thursdays and my diary is at: https://www.psyctc.org/pelerinage2016/ceworkdiary/ Beware: French time, generally an hour ahead of UK. ______________________________________________ [email protected] mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel ______________________________________________ [email protected] mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
