R package documentation help file

Package development
1

I am developing an R data package and I have, for example, 3 sets of similar data:

data_a
data_b
data_c

How can I make a help documentation file for the 3 data sets togehter, no specific for each data set?

2

See the roxygen2 documentation, in particular @describeIn is probably what you want here: Reusing documentation • roxygen2

3

Thank you Gabor.

Would "aliases" do a similar Job?

4

@describeIn creates \alias{} tags I believe, that's how it works.

You could also just document one data set, and use @aliases to refer to the other two, but then roxygen2 does not know about the other two, so it will not auto-generate any docs for them. Which might be fine for data sets, I don't know.

5

Thank you very much Gabor.

6

This topic was automatically closed after 45 days. New replies are no longer allowed.


If you have a query related to it or one of the replies, start a new topic and refer back with a link.