One relatively simple mechanism would be to export a function that
simply returns the internal lookup data, and to then document that
function.
On Sat, 22 Mar 2025 at 23:05, Michael Dewey wrote:
>
> Dear Charles
>
> I agree and in fact that was in the back of my mind when I started this.
> I felt
Dear Charles
I agree and in fact that was in the back of my mind when I started this.
I felt I should document it even though the chances of anyone wanting to
access it still less edit it were almost indistinguishable from zero. I
am reluctant to use a suggestion like yours as then I will have
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.
gi Boshnakov
From: R-package-devel on behalf of
Michael Chirico
Sent: 20 March 2025 17:05
To: Kevin R. Coombes
Cc: r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] How and where do I document sysdata.rda
Here are about 60 CRAN packages discussin
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
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
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
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
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
