
Export parsed sources to HTML or Markdown
Source:R/export_to_html.R
, R/export_to_markdown.R
exporting_sources.Rd
These function can be used to convert one or more parsed sources to HTML, or to convert all sources to tabbed sections in Markdown.
Usage
export_to_html(
input,
output = NULL,
template = "default",
fragment = FALSE,
preventOverwriting = rock::opts$get(preventOverwriting),
encoding = rock::opts$get(encoding),
silent = rock::opts$get(silent)
)
export_to_markdown(
input,
heading = "Sources",
headingLevel = 2,
template = "default",
silent = rock::opts$get(silent)
)
Arguments
- input
An object of class
rock_parsedSource
(as resulting from a call toparse_source
) or of classrock_parsedSources
(as resulting from a call toparse_sources
.- output
For
export_to_html
, either NULL to not write any files, or, ifinput
is a singlerock_parsedSource
, the filename to write to, and ifinput
is arock_parsedSources
object, the path to write to. This path will be created with a warning if it does not exist.- template
The template to load; either the name of one of the ROCK templates (currently, only 'default' is available), or the path and filename of a CSS file.
- fragment
Whether to include the CSS and HTML tags (
FALSE
) or just return the fragment(s) with the source(s) (TRUE
).- preventOverwriting
For
export_to_html
, whether to prevent overwriting of output files.- encoding
For
export_to_html
, the encoding to use when writing the exported source(s).- silent
Whether to suppress messages.
- heading, headingLevel
For
Examples
### Get path to example source
examplePath <-
system.file("extdata", package="rock");
### Parse a selection of example sources in that directory
parsedExamples <- rock::parse_sources(
examplePath,
regex = "(test|example)(.txt|.rock)"
);
#> Error in rock::parse_source(file = filename, ignoreOddDelimiters = ignoreOddDelimiters, encoding = encoding, postponeDeductiveTreeBuilding = TRUE, removeSectionBreakRows = removeSectionBreakRows, removeIdentifierRows = removeIdentifierRows, filesWithYAML = filesWithYAML, removeEmptyRows = removeEmptyRows, mergeAttributes = FALSE, silent = silent): object 'notes' not found
### Export results to a temporary directory
tmpDir <- tempdir(check = TRUE);
prettySources <-
export_to_html(input = parsedExamples,
output = tmpDir);
#> Error: object 'parsedExamples' not found
### Show first one
print(prettySources[[1]]);
#> Error: object 'prettySources' not found