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

[Michael Dewey]

I promised I would update on this.

I now realise that what I was tryig to do was logically impossible. I 
was trying to hide the data set (achieved) but also hide the 
documentation. That makes no sense as anyone wanting to change the 
dataset would not know where to find the documentation. The probabiliy 
anyone would want to edit it is almost indsitinguishable from zero but 
it is as Charles suggests a good principle.

So the answer is to document it in the usual way and use the keyword 
internal. The main difference from a standard Rd file for data is the 
usage statement. As georgi pointed out this just consists of the dataset 
name not data(datasetname).

Thanks for all your help on this and sorry it took so long to respond.

Michael

On 20/03/2025 14:39, Lists wrote:
> 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 which I turned up online involves doing it all 
> indirectly using various packages. I do not want to do that, I am quite 
> happy editing files by hand and moving them to where I want them by 
> hand. So what I need is to know where I should put the documentation and 
> what format it should be assuming it is not an Rd file.
> 
> Of course what I want may be impossible and I just need to document it 
> in the script which creates it but that seems messy.
> 
> Michael Dewey
> 
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel

-- 
Michael Dewey