validate_factory: Inspect and validate the content of a factory

In tjtnew/reportfactory: Lightweight Infrastructure for Handling Multiple Rmarkdown Documents

Description

validate_factory() can be used to inspect the content of a factory and make everything looks fine. This includes various sanity checks listed in details that will error if a problem is found.

Usage

validate_factory(factory = ".", allow_duplicates = TRUE)

Arguments

factory	The path to the report factory or a folder within the desired factory. Defaults to the current directory.
allow_duplicates	A logical indicating duplicate filenames are allowed across folders.

Details

Checks run on the factory include:

• the factory directory exists;

• the factory_config file exist;

• all mandatory folders exist - by default these are 'report_sources/' and 'outputs/';

• (optionally) all .Rmd reports have unique names once outside their folders.

Value

A list with 4 entries:

• root - the root folder path of the factory;

• factory_name - the name of the report factory;

• report_sources - the name of the report_sources folder; and

• outputs - the name of the outputs folder.

tjtnew/reportfactory documentation built on Dec. 31, 2020, 8:40 a.m.