copernicus_article: Copernicus journals format.

Description Usage Arguments Details Value Note References Examples

View source: R/copernicus_article.R

Description

Format for creating submissions to Copernicus journals.

Usage

1
2
3
4
5
6
7
8
9
copernicus_article(
  ...,
  keep_tex = TRUE,
  highlight = NULL,
  citation_package = "natbib",
  md_extensions = c("-autolink_bare_uris", "-auto_identifiers")
)

copernicus_journal_abbreviations(journal_name = "*")

Arguments

...

Additional arguments to rmarkdown::pdf_document(). Note: extra_dependencies are not allowed as Copernicus does not support additional packages included via \usepackage{}.

keep_tex

Keep the intermediate tex file used in the conversion to PDF

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.

citation_package

The LaTeX package to process citations, natbib or biblatex. Use default if neither package is to be used, which means citations will be processed via the command pandoc-citeproc.

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

journal_name

A regular expression to filter the by the journal name, see pattern in grep; defaults to *.

Details

This was adapted from https://publications.copernicus.org/for_authors/manuscript_preparation.html.

An number of required and optional manuscript sections, e.g. acknowledgements, competinginterests, or authorcontribution, must be declared using the respective properties of the R Markdown header - see skeleton file.

Version: Based on copernicus_package.zip in the version 6.2, 15 January 2021, using copernicus.cls in version 9.25.

Copernicus journal abbreviations: You can use the function copernicus_journal_abbreviations() to get the journal abbreviation for all journals supported by the Copernicus article template.

Important note: The online guidelines by Copernicus are the official resource. Copernicus is not responsible for the community contributions made to support the template in this package. Copernicus converts all typeset TeX files into XML, the expressions and markups have to be highly standardized. Therefore, please keep the following in mind:

Value

An R Markdown output format.

Note

If you use rmarkdown::pdf_document(), all internal references (i.e. tables and figures) must use \ref{} whereas with bookdown::pdf_document2(), you can additionally use \@ref().

References

Manuscript preparation guidelines for authors. https://publications.copernicus.org/for_authors/manuscript_preparation.html

Examples

1
2
3
4
5
6
7
8
names(copernicus_journal_abbreviations())
copernicus_journal_abbreviations(journal_name = "Science Data")
## Not run: 
library("rmarkdown")
draft("MyArticle.Rmd", template = "copernicus", package = "rticles")
render("MyArticle/MyArticle.Rmd")

## End(Not run)

rticles documentation built on June 23, 2021, 5:06 p.m.