f1000_article: F1000Research article format

In BiocWorkflowTools: Tools to aid the development of Bioconductor Workflow packages

Description

Format for creating F1000Research software tool articles.

Usage

f1000_article(
  toc = FALSE,
  number_sections = FALSE,
  fig_width = 5.67,
  fig_height = fig_width,
  fig_align = "center",
  keep_tex = TRUE,
  citation_package = "natbib",
  md_extensions = "+link_attributes",
  pandoc_args = "--wrap=preserve",
  ...
)

Arguments

toc	TRUE to include a table of contents in the output
number_sections	TRUE to number section headings
fig_width	Default width (in inches) for figures
fig_height	Default height (in inches) for figures
fig_align	Default alignment of figures. Possible values are "center" (default) "left" and "right".
keep_tex	Keep the intermediate tex file used in the conversion to PDF
citation_package	The LaTeX package to process citations, natbib or biblatex. Use none if neither package is to be used.
md_extensions	Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.
pandoc_args	Additional command line options to pass to pandoc
...	Arguments to pdf_document

Details

Creates LaTeX sources which can be submitted to F1000Research through Overleaf.

Value

R Markdown output format to pass to render

Citations

R Markdown supports automatic generation of citations. You can find more information on the markdown citation syntax in the Bibliographies and Citations article in the R Markdown online documentation.

A bibliography file can be specified using the bibliography metadata field in the document's YAML header. Metadata variables for customizing citation style include:

biblio-style

Bibliography style (e.g. "unsrtnat", "plainnat")

natbiboptions

Options to natbib LaTeX package (e.g. "number", "super", "round")

biblatexoptions

Options to biblatex LaTeX package

Examples

## Not run: 

rmarkdown::draft("MyArticle.Rmd", template="f1000_article", package="BiocWorkflowTools")

## End(Not run)

BiocWorkflowTools documentation built on Nov. 8, 2020, 8:04 p.m.