Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Charles Plessy
Le Thu, Mar 20, 2025 at 12:56:49PM -0400, Kevin R. Coombes a ??crit : > If it is *only *in sysdata.Rda, then it is accessible to your package > code but is not available to users. (They can't, for example, use the > "data" function to load it themselves.) So, there is no reason to > document it.

Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Georgi Boshnakov
> > I am afraid that does not work if the data file is in sysdata.rda. I > > had to remove my existing Rd file to get the package to pass checks Maybe give more details? Did you use `data(xxx)` in the usage statement? If so, replace it with just the name of the dataset. Georgi Boshnakov __

Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Michael Chirico
Here are about 60 CRAN packages discussing sysdata in their Rd files: https://github.com/search?q=org%3Acran+path%3A.Rd+%2F%28%5B%5E%7B+%5D%7C%5B%5Ed%5D%5C%7B%29%5Cs*sysdata%2F&type=code You might take a cue from them. Indeed \keyword{internal} is common there. On Thu, Mar 20, 2025 at 9:57 AM Ke

Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Kevin R. Coombes
If it is *only *in sysdata.Rda, then it is accessible to your package code but is not available to users. (They can't, for example, use the "data" function to load it themselves.) So, there is no reason to document it. Just like there is no reason to document functions in your R scripts that we

Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Lists
Dear Jeff I am afraid that does not work if the data file is in sysdata.rda. I had to remove my existing Rd file to get the package to pass checks. Michael On 20/03/2025 15:15, Jeff Newmiller wrote: Did you seriously look for instructions and not find [1]? And why do you think the answer sh

Re: [R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Jeff Newmiller via R-package-devel
Did you seriously look for instructions and not find [1]? And why do you think the answer should not involve Rd files? Documentation in R packages is what Rd files are for. If you don't want to mess with Rd files then you have no choice but to use something like the Roxygen package to mess with

[R-pkg-devel] How and where do I document sysdata.rda

2025-03-20 Thread Lists
I want to put a look-up table into sysdata.rda to avoid having to compute it everytime. At the moment I create it and save the resulting file and then manually copy it to sysdata.rda. This works but the package now contains no documentation about the look-up table. Most of the information whic