Package 'documenter'

Create a template annotation file.

Description

Create a template annotation file.

Usage

create_annotation_file(title = NULL, annotation_file = NULL)

Arguments

title	The title within the documentation file.
annotation_file	The path to the annotation file to be written.

Examples

## Not run: create_annotation_file()

---

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

## Not run: 
input <- system.file("extdata", "example", package = "documenter")
document_it(
input_directory = input,
output_file = "documentation",
annotation_file = NULL
)

## End(Not run)

---

Extract annotations from a yaml annotation file.

Description

Extract annotations from a yaml annotation file.

Usage

extract_annotations(annotation_yml, title)

Arguments

annotation_yml	The yaml object read by document_it.
title	The title of the output document.

---

Fix a file path.

Description

Fix a file path.

Usage

fix_path(path)

Arguments

path	The path needing to be fixed.

---

Insert each element of a vector into a document as a string of paragraphs.

Description

Insert each element of a vector into a document as a string of paragraphs.

Usage

insert_paragraphs(denv, vec)

Arguments

denv	The environment of the input docx object.
vec	The character vector to be inserted. Each element should correspond to a separate paragraph.

Examples

## Not run: 
insert_paragraphs(obj, vec)

## End(Not run)

---