markdownToLatex {BiocWorkflowTools} | R Documentation |
Turn Rmarkdown version of workflow document into latex file that can be uploaded to F1000 Overleaf.
markdownToLatex(input, output = NULL, compress = TRUE)
input |
path to Rmd file to be converted |
output |
Specifies the folder where the output should be written. If left NULL this defaults to the same folder as the input file. |
compress |
If TRUE a zip file of the output directory is created, which can be uploaded to Overleaf |
This function has been deprecated. The recommended way to create the F1000
LaTeX and pdf version is to ensure your Rmarkdown document has the property
'output: BiocWorkflowTools::f1000_article' in the YAML header, and to use
the function render
in the rmarkdown
pacakge
on the document (or use the 'knit' button in RStudio).
No value is returned, but a tex file is written to disk, and is given an identical name to the input Rmd except for the file extension. Accompanying figures are copied to the output directory long with style files and figures required to match the F1000 Research format.
Optionally the output directory can be compressed into a zip archive,
which can then be uploaded to Overleaf either manually, or by passing it
to the function uploadToOverleaf
.
## Not run: example_Rmd <- system.file('examples/f1000_software_example.Rmd', package = "BiocWorkflowTools") output_dir <- file.path(tempdir(), 'example') markdownToLatex(input = example_Rmd, output = output_dir, compress = TRUE) ## End(Not run)