Description Documentation options Conventions
As stated this is just a sandbox for experimenting with the different elements of R packages.
Here too we can of course use all the
available object documentation @tags
- if applicable.
Here are some recommendations for documenting packages:
If provided, put the package documentation in file name <package-name>.R.
It has to be labelled with @docType
package
.
It must have a @name
specifying the package name.
Since it must not contain functions, it has to document NULL
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.