document_it: Generate documentation for the files of a directory.

Description Usage Arguments Examples

Description

Generate documentation for the files of a directory.

Usage

1
2
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

1
2
3
4
5
6
input <- system.file("extdata", "example", package = "documenter")
document_it(
input_directory = input,
output_file = file.path(tempdir(), "documentation"),
annotation_file = NULL
)

MAMC-DCI/documenter documentation built on May 9, 2019, 2:19 a.m.