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
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")
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)
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.