dataRd: Prototype of an R Documentation File

In USGS-R/smwrData: Example hydrologic data to support statistical methods in water resources

Prototype of an R Documentation File

Description

Facilitate the constructing of files documenting R data.frames.

Usage

dataRd(obj, file = NULL, obname = deparse(substitute(obj)),
  format = c("roxygen", "man"))

Arguments

obj	the name of the dataset to document.
file	the output filename.
obname	a character string giving the name of the object.
format	a character string specifying the format of the output; "roxygen" generates a file that is an R script with a roxygen header and should be placed in the R folder and "man" generates a file that is an Rd file and should be placed in the man folder.

Details

When dataRd is used within a loop, use of obname facilitates using character strings for objects.

Value

The object name, from obname.

Note

The prototype file must be edited to include descriptions of the columns and complete the source and example.

See Also

prompt

USGS-R/smwrData documentation built on Oct. 18, 2022, 9:56 a.m.