The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Type: Package
Title: Documents Files
Version: 0.1.3
Maintainer: Zachary Colburn <zcolburn@gmail.com>
Description: 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.
License: MIT + file LICENSE
Encoding: UTF-8
Imports: officer, magrittr, htmltools, yaml
Suggests: covr, testthat, knitr, rmarkdown
VignetteBuilder: knitr
RoxygenNote: 7.1.2
NeedsCompilation: no
Packaged: 2022-12-27 21:12:05 UTC; zcolburn
Author: Zachary Colburn [aut, cre], Madigan Army Medical Center - Department of Clinical Investigation [cph, fnd]
Repository: CRAN
Date/Publication: 2023-01-05 17:00:02 UTC

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)

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.