rmdfiltr (version 0.1.4)

add_lua_filter: Add filter to pandoc arguments

Description

Adds a filter call to the vector of pandoc command line arguments.

Usage

add_lua_filter(args = NULL, filter_name, error = TRUE)
add_wordcount_filter(args = NULL, error = TRUE)
add_charcount_filter(args = NULL, error = TRUE)
add_replace_ampersands_filter(args = NULL, error = TRUE)
add_doi2cite_filter(args = NULL, error = TRUE)
add_citeproc_filter(args = NULL, error = TRUE)
add_custom_filter(args = NULL, filter_path, lua = FALSE, error = TRUE)

Arguments

args

Character. (Vector of) pandoc command line arguments.

filter_name

Character. Name(s) of the Lua filter to add. See details.

error

Logical. Whether to throw an error if (required version of) pandoc is not available.

filter_path

Character. Path to filter file.

lua

Logical. Whether the filter(s) was written in Lua (results in --lau-filter-call) or not (results in --filter-call). Will be recycled to fit length of filter_path.

Details

The following Lua filters are available from rmdfiltr. Convenience functions named after the filter are available (e.g. add_*_filter()). For details, please also refer to the vignettes.

replace_ampersands

Searches for citations added by pandoc-citeproc and replaces & with and in all in-text citations (e.g., as required by APA style). If lang is specified in the documents YAML front matter, the corresponding translation is used, if available. Be sure to set citeproc: no in the YAML front matter of the document and call pandoc-citeproc manually (e.g., using add_citeproc_filter). For details see vignette("replace_ampersands", package = "rmdfiltr").

wordcount

The body of the text and reference sections are counted separately. The word count for the text body does not contain, tables or images (or their captions). The filter reports the word count in the console or the R Markdown tab in 'RStudio'. For details see vignette("wordcount", package = "rmdfiltr").

charcount

Only the body of the text is counted. The character count for the text body does not contain, tables or images (or their captions), but includes spaces. The filter reports the character count in the console or the R Markdown tab in 'RStudio'.

doi2cite

Searches for DOI-citation tags in the text, retrieves the bibliographic information from CrossRef, stores it in a BibTeX file, and replaces the DOI-citation tags with the corresponding BibTeX keys. For details see vignette("doi2cite", package = "rmdfiltr").

Examples

add_lua_filter(NULL, "wordcount", error = FALSE)
add_wordcount_filter(NULL, error = FALSE)
add_charcount_filter(NULL, error = FALSE)
add_replace_ampersands_filter(NULL, error = FALSE)
add_doi2cite_filter(NULL, error = FALSE)
add_citeproc_filter(NULL, error = FALSE)
add_custom_filter(NULL, filter_path = "foo/bar", error = FALSE)