document_it {documenter}R Documentation

Generate documentation for the files of a directory.

Description

Generate documentation for the files of a directory.

Usage

document_it(input_directory, output_file, annotation_file = NULL, title = NULL)

Arguments

input_directory

The directory of files to be documented.

output_file

The path to the output file that will be generated.

annotation_file

The path to the annotation file if present.

title

The title of the output document.

Examples

input <- system.file("extdata", "example", package = "documenter")
document_it(
input_directory = input,
output_file = file.path(tempdir(), "documentation"),
annotation_file = NULL
)

[Package documenter version 0.1.2 Index]