update PR, see comment in #172

rstudio · Jul 30, 2018 · edaaa5d · edaaa5d
1 parent 1278161
commit edaaa5d
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 38 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -27,8 +27,9 @@ Authors@R: c(
   person("Marc-Andre", "Desautels", role = c("aut", "cph"), email = "marc-andre.desautels@cstjean.qc.ca"),
   person("Dominik", "Leutnant", role = c("aut", "cph"), email = "leutnant@fh-muenster.de"),
   person(family = "MDPI", role = c("aut", "cph")),
-  person("Oğuzhan", "Öğreden", role = c("aut"), comment = c(ORCID = "0000-0002-9949-3348"),
-  person("Daniel", "Nüst", role = c("aut", "cph"), email = "daniel.nuest@uni-muenster.de"))
+  person("Oğuzhan", "Öğreden", role = c("aut"), comment = c(ORCID = "0000-0002-9949-3348")),
+  person("Daniel", "Nüst", role = c("aut", "cph"), email = "daniel.nuest@uni-muenster.de", comment = c(ORCID = "0000-0002-0024-5046"))
+  )
 Description: A suite of custom R Markdown formats and templates for
   authoring journal articles and conference submissions.
 License: GPL-3

diff --git a/NEWS b/NEWS
@@ -3,6 +3,8 @@ rticles 0.6 (unreleased)
 
 - Added the template for the SAGE Journals (thanks, @oguzhanogreden, #181).
 
+- Added the template for Copernicus Publications journals (thanks, @nuest, #172).
+
 rticles 0.5
 ---------------------------------------------------------------------
 

diff --git a/R/copernicus_article.R b/R/copernicus_article.R
@@ -7,6 +7,7 @@
 #' @param base_format The function to use for the base format of the article.
 #'   By default, this is \code{rmarkdown::pdf_document}, but to use bookdown's
 #'   cross-referencing feature, this can be set to \code{bookdown::pdf_document2}
+#' @param journal_name A regular expression to filter the by the journal name, see \code{pattern} in \code{\link[base]{grep}}; defaults to \code{*}.
 #'
 #' @return R Markdown output format to pass to
 #'   \code{\link[rmarkdown:render]{render}}
@@ -18,6 +19,8 @@
 #'
 #' \strong{Version:} Based on copernicus_package.zip in the version 5.0, 21 March 2018, using \code{copernicus.cls} in version 8.67, 30 January 2018
 #'
+#' \strong{Copernicus journal abbreviations:} You can use the function \code{copernicus_journal_abbreviations()} to get the journal abbreviation for all journals supported by the copernicus article template.
+#'
 #' \strong{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.
 #' Copenicus converts all typeset TeX files into XML, the expressions and markups have to be highly standardized.
@@ -41,7 +44,8 @@
 #' \url{https://publications.copernicus.org/for_authors/manuscript_preparation.html}
 #'
 #' @examples
-#'
+#' names(copernicus_journal_abbreviations())
+#' copernicus_journal_abbreviations(journal_name = "Science Data")
 #' \dontrun{
 #' library("rmarkdown")
 #' draft("MyArticle.Rmd", template = "copernicus_article", package = "rticles")
@@ -57,7 +61,7 @@ copernicus_article <- function(...,
                            "-autolink_bare_uris", # disables automatic links, needed for plain email in \correspondence
                            "-auto_identifiers"    # disables \hypertarget commands
                            )) {
-  if (inherits(base_format, "character")) {
+  if (is.character(base_format)) {
     FMT <- eval(parse(text = base_format))
   } else {
     FMT <- match.fun(base_format)
@@ -112,18 +116,9 @@ copernicus_journals <- list(
   "Wind Energy Science" = "wes"
 )
 
-#' Copernicus journal abbreviations
-#'
-#' Get the journal abbreviation for all journals supported by the copernicus article template.
-#'
-#' @param name A regular expression to filter the by the journal name, see \code{pattern} in \code{\link[base]{grep}}; defaults to \code{*}.
-#'
-#' @examples
-#' names(copernicus_journal_abbreviations())
-#' copernicus_journal_abbreviations(name = "Science Data")
-#'
+#' @rdname copernicus_article
 #' @export
-copernicus_journal_abbreviations <- function(name = "*") {
-  journal <- copernicus_journals[grepl(pattern = name, x = names(copernicus_journals), ignore.case = TRUE)]
+copernicus_journal_abbreviations <- function(journal_name = "*") {
+  journal <- copernicus_journals[grepl(pattern = journal_name, x = names(copernicus_journals), ignore.case = TRUE)]
   return(unlist(journal))
 }
diff --git a/inst/rmarkdown/templates/copernicus_article/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/copernicus_article/skeleton/skeleton.Rmd
@@ -1,6 +1,6 @@
 ---
 title: Template for preparing your manuscript submission to Copernicus journals using RMarkdown
-journal: "`r rticles::copernicus_journal_abbreviations(name = 'communication')`"
+journal: "`r rticles::copernicus_journal_abbreviations(journal_name = 'communication')`"
 author:
   - given_name: Daniel
     surname: Nüst

diff --git a/man/copernicus_article.Rd b/man/copernicus_article.Rd
diff --git a/man/copernicus_journal_abbreviations.Rd b/man/copernicus_journal_abbreviations.Rd
diff --git a/tests/testit/test-formats.R b/tests/testit/test-formats.R
@@ -42,3 +42,4 @@ test_format("peerj_article")
 test_format("amq_article")
 test_format("mdpi_article")
 test_format("mnras_article")
+test_format("copernicus_article")