Documents Files

It is sometimes necessary to create documentation for all files in a directory. Doing so by hand can be very tedious. This task is made fast and reproducible using the functionality of 'documenter'. It aggregates all text files in a directory and its subdirectories into a single word document in a semi-automated fashion.


An R package for documenting files

CRAN_Status_Badge Travis-CI Build Status Build status Coverage Status

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.

News

documenter 0.1.1

  • Modified the document_it example and made it runnable. The example in the vignette was also updated.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("documenter")

0.1.1 by Zachary Colburn, 5 months ago


Browse source code at https://github.com/cran/documenter


Authors: Zachary Colburn [aut, cre] , Madigan Army Medical Center - Department of Clinical Investigation [cph, fnd]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports officer, magrittr, htmltools, xml2, yaml

Suggests covr, testthat, knitr, rmarkdown


See at CRAN