tags-rd-datasets

@format

@source

Learn the full details in <code>vignette('rd-datasets')</code>.
Key tags:<ul>
<li><code>@format ${1:description}</code>: Describe the type/shape of a dataset. If the dataset is a data frame, include a description of each column. If not supplied, will be automatically generated by <code>object_format()</code>.</li>
<li><code>@source ${1:description}</code>: Describe where the dataset came from. Provide a link to the original source (if possible) and briefly describe any manipulation that you performed when importing the data.</li>
</ul>

Generate your Rd documentation, 'NAMESPACE' file, and
collation field using specially formatted comments. Writing
documentation in-line with code makes it easier to keep your
documentation up-to-date as your requirements change. 'roxygen2' is
inspired by the 'Doxygen' system for C++.

Hadley Wickham

roxygen2

In-Line Documentation for R

Peter Danenberg

Gábor Csárdi

Manuel Eugster

Posit Software, PBC 

tags-rd-datasets function

Tags for documenting datasets — tags-rd-datasets

Tags for documenting datasets

tags-rd-datasets: Tags for documenting datasets

Description

Usage

Arguments

See Also