Dependency: Create objects of class 'Dependency'

In humburg/reportmd: Scientific reports with RMarkdown

Description

Objects of the class are used to store information about child docxuments.

Usage

Dependency(label, document, source, chunks, title, cache, index, ...)

Arguments

label	The label associated with the document.
document	Path to the output document. This should be relative to the location of the main document.
source	Path to source (i.e. RMarkdown) file used to generate document.
chunks	List of chunk labels indicating the code chunks required.
title	The title of the document.
cache	Path to cache directory. If this is missing an attempt will be made to guess the location if source is present.
index	Named list of data.frames indexing tables and figures. Alternatively entries may provide the names of files with the relevant information.
...	Additional arguments are ignored.

Details

The source and title arguments may be omitted. If no title is provided an attempt is made to extract it from the header of the source file or, if that is unavailable (or no title was found), the output document (but currently only for html output).

Value

An object of class Dependency. Such objects have fields

label	The label used to refer to this document.
document	The path to the output document.
source	The source document used to generate the output (may be NULL).
title	The document title. If no title is available this will be 'Untitled'
cache	Location of the cache directory.
index	List of data.frames with information on all Figures and Tables generated by the dependency.
files	Path to directory containing additional files associated with the dependency.

humburg/reportmd documentation built on May 17, 2019, 9:13 p.m.