Get the full paths of Lua filters in an R package

Source: R/util.R

Lua filters stored in a source package in the inst/rmarkdown/lua directory will be installed to the rmarkdown/lua directory in the package path. This function finds the full paths of the Lua filters in the installed packages.

pkg_file_lua(filters = NULL, package = "rmarkdown")

Arguments

filters

A character vector of filenames for Lua filters to be retrieved in rmarkdown/lua folder of the package. By default (NULL), if none is provided, it returns all filters in that folder.
package

The name of the package in which to look for the filters.

Value

A character vector of absolute file paths for the Lua filter from the package. The returned paths have been processed by pandoc_path_arg(), so they are ready to be used by Pandoc.

Examples

# list all Lua filters stored in the rmarkdown package
pkg_file_lua()

#> [1] "/data/GHE/deployment/deployments/2021-06-21/renv/library/R-4.0/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/latex-div.lua"      
#> [2] "/data/GHE/deployment/deployments/2021-06-21/renv/library/R-4.0/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/number-sections.lua"
#> [3] "/data/GHE/deployment/deployments/2021-06-21/renv/library/R-4.0/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/pagebreak.lua"      
#> [4] "/data/GHE/deployment/deployments/2021-06-21/renv/library/R-4.0/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/shared.lua"         
# get a specific filter
pkg_file_lua(c("pagebreak.lua", "latex_div.lua"))

#> [1] "/data/GHE/deployment/deployments/2021-06-21/renv/library/R-4.0/x86_64-pc-linux-gnu/rmarkdown/rmarkdown/lua/pagebreak.lua"