The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

documenter

An R package for documenting files

CRAN_Status_Badge R-CMD-check Build status Coverage Status DOI

Installation

The package can be installed via CRAN or GitHub using either of the following commands.

# Install via CRAN.
install.packages("documenter")
# Install via GitHub.
install.packages("devtools")
devtools::install_github("mamc-dci/documenter")

Usage

The package can be loaded with the library function.

# Load the package.
library(documenter)

After loading the package, the files of a directory can be documented using the document_it function. This function can be executed as follows:

document_it(
  input_directory = "man",
  output_file = "documentation",
  annotation_file = NULL
)

Disclaimer

The views expressed are those of the author(s) and do not reflect the official policy of the Department of the Army, the Department of Defense or the U.S. Government.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.