ieee_article() add journal support

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: rticles
 Type: Package
 Title: Article Formats for R Markdown
-Version: 0.21.3
+Version: 0.21.4
 Authors@R: c(
   person("JJ", "Allaire", role = "aut", email = "[email protected]"),
   person("Yihui", "Xie", role = c("aut", "cre"), email = "[email protected]", comment = c(ORCID = "0000-0003-0645-5666")),
@@ -49,7 +49,8 @@ Authors@R: c(
   person("Greg", "Macfarlane", role = c("ctb"), email = "[email protected]", comment = c(github = "gregmacfarlane")),
   person("Matthias", "Templ", role = c("ctb"), email = "[email protected]", comment = c(ORCID = "0000-0002-8638-5276", github = "matthias-da")),
   person("Alvaro", "Uzaheta", role = c("ctb"), email = "[email protected]", comment = c(github = "auzaheta")),
-  person("JooYoung", "Seo", role=c("ctb"), email="[email protected]", comment = c(ORCID = "0000-0002-4064-6012"))
+  person("JooYoung", "Seo", role=c("ctb"), email="[email protected]", comment = c(ORCID = "0000-0002-4064-6012")),
+  person("Karel", "Kroeze", role = c("ctb"), email = "[email protected]", comment = c(ORCID = "0000-0002-7000-7377", github = "karel-kroeze"))
   )
 Description: A suite of custom R Markdown formats and templates for
   authoring journal articles and conference submissions.

NEWS.md

@@ -6,6 +6,8 @@
 
 - Add `trb_article()` for annual meeting submissions to the Transportation Research Board Annual Meeting (thanks, @gregmacfarlane, #427).
 
+- `ieee_article()` now supports journal articles with different defaults, using `journal` classoption for `IEEEtran` document class. This brings a pandoc minimum requirement of 2.8 for conference paper and 2.10 for journal article. A new demo Rmd file has been added in the bundle when creating the template for `ieee_article()` - see this file and help page for new argument and syntax (thanks, @Karel-Kroeze, #375). 
+
 # rticles 0.21
 
 ## NEW FEATURES

R/ieee_article.R

@@ -4,14 +4,22 @@
 #' <http://www.ieee.org/publications_standards/publications/authors/author_templates.html>.
 #'
 #' Presently, only the `"conference"` paper mode offered by the
-#' `IEEEtran.cls` is supported.
+#' `IEEEtran.cls` is supported, with experimental support for the
+#' `"journal"` mode.
+#'
+#' # Pandoc requirement
+#'
+#' This format requires at least Pandoc 2.8 and 2.10 when `journal` is used.
 #'
 #' @inheritParams rmarkdown::pdf_document
 #' @param draftmode Specify the draft mode to control spacing and whether images
 #' should be rendered. Valid options are: `"final"` (default), `"draft"`,
 #' `"draftcls"`, or `"draftclsnofoot"`.
 #' @param hyphenfixes A `character` value that provides the correct
 #' hyphenations for ambiguous words. Separate new words with spaces.
+#' @param journal Running Header to use for a journal paper. When set,
+#'   classoption `journal` will be used instead of `conference`.
+#'   `number_sections` will also default to `TRUE` in this case.
 #' @param IEEEspecialpaper  A `character` value containing the publication's
 #' special paper designation.
 #' @param with_ifpdf A `logical` value turning on (`TRUE`) or off
@@ -39,6 +47,7 @@
 ieee_article <- function(
   draftmode   = c("final", "draft", "draftcls", "draftclsnofoot"),
   hyphenfixes      = "op-tical net-works semi-conduc-tor",
+  journal = NULL,
   IEEEspecialpaper = "",
   with_ifpdf       = FALSE,
   with_cite        = FALSE,
@@ -49,17 +58,34 @@ ieee_article <- function(
   with_dblfloatfix = FALSE,
   keep_tex         = TRUE,
   pandoc_args = NULL,
+  citation_package = "default",
   md_extensions    = c("-autolink_bare_uris"),
+  number_sections = FALSE,
   ...
 ) {
 
+  rmarkdown::pandoc_available("2.8", error = TRUE)
+
   args <- c()
 
   draftmode <- match.arg(draftmode)
   args <- c(args, "draftmode" = draftmode)
 
   args <- c(args, "hyphenfixes" = hyphenfixes)
 
+
+  # Some check when journal mode is set
+  if (!is.null(journal)) {
+    # Add as Pandoc's variable
+    args <- c(args, "journal" = journal)
+    # activate number_section by default
+    if(missing(number_sections)) number_sections <- TRUE
+    # New author syntax needs to be used which requires a recent pandoc
+    if (!rmarkdown::pandoc_available("2.10")) {
+      stop("Using `journal` mode for `ieee_article()` requires Pandoc >= 2.10", call. = FALSE)
+    }
+  }
+
   # Avoid declaration of pandoc variable if field is empty
   if (nchar(IEEEspecialpaper) > 1) {
     args <- c(args, "IEEEspecialpaper" = IEEEspecialpaper)
@@ -83,6 +109,7 @@ ieee_article <- function(
   pdf_document_format(
     "ieee", pandoc_args = c(pandoc_arg_list, pandoc_args),
     keep_tex = keep_tex, md_extensions = md_extensions,
+    number_sections = number_sections, citation_package = citation_package,
     ...
   )
 }

inst/rmarkdown/templates/ieee/resources/template.tex

@@ -50,7 +50,11 @@
 % The testflow support page is at:
 % http://www.michaelshell.org/tex/testflow/
 
-\documentclass[conference,$if(fontsize)$$fontsize$,$endif$$if(draftmode)$$draftmode$,$endif$$if(papersize)$$papersize$,$endif$$for(classoption)$$classoption$$sep$,$endfor$]{IEEEtran}
+% *** rticle changes for journal/conference mode.
+% adding journal as an override for conference mode to maintain backwards
+% compatibility. Any future expansions to further modes will have to come up with
+% a cleverer solution, or introduce breaking changes.
+\documentclass[$if(journal)$journal$else$conference$endif$,$if(fontsize)$$fontsize$,$endif$$if(draftmode)$$draftmode$,$endif$$if(papersize)$$papersize$,$endif$$for(classoption)$$classoption$$sep$,$endfor$]{IEEEtran}
 % Some Computer Society conferences also require the compsoc mode option,
 % but others use the standard conference format.
 %
@@ -335,7 +339,7 @@
 \bibliographystyle{$if(biblio-style)$$biblio-style$$else$plainnat$endif$}
 $endif$
 $if(biblatex)$
-\usepackage[backend=bibtex,citestyle=ieee,style=numeric$if(citation_sorting)$,sorting=$citation_sorting$$endif$]{biblatex}
+\usepackage[backend=bibtex,citestyle=ieee,style=$if(biblio-style)$$biblio-style$$else$numeric$endif$,$if(citation_sorting)$sorting=$citation_sorting$,$endif$$for(biblatexoptions)$$biblatexoptions$$sep$,$endfor$]{biblatex}
 $if(bibliography)$
 $for(bibliography)$
 \addbibresource{$bibliography$}
@@ -382,7 +386,7 @@
             breaklinks=true}
 \urlstyle{same}  % don't use monospace font for urls
 
-% Pandoc toggle for numbering sections (defaults to be off)
+% Pandoc toggle for numbering sections
 $if(numbersections)$
 \setcounter{secnumdepth}{$if(secnumdepth)$$secnumdepth$$else$5$endif$}
 $else$
@@ -406,15 +410,18 @@
   \everypar{\setlength{\hangindent}{\cslhangindent}}\ignorespaces$endif$}%
   {\par}
 % For Pandoc 2.11+
+\newlength{\cslentryspacingunit} % times entry-spacing
+\setlength{\cslentryspacingunit}{\parskip}
 \newenvironment{CSLReferences}[2] % #1 hanging-ident, #2 entry spacing
  {% don't indent paragraphs
   \setlength{\parindent}{0pt}
   % turn on hanging indent if param 1 is 1
-  \ifodd #1 \everypar{\setlength{\hangindent}{\cslhangindent}}\ignorespaces\fi
-  % set entry spacing
-  \ifnum #2 > 0
-  \setlength{\parskip}{#2\baselineskip}
+  \ifodd #1
+  \let\oldpar\par
+  \def\par{\hangindent=\cslhangindent\oldpar}
   \fi
+  % set entry spacing
+  \setlength{\parskip}{#2\cslentryspacingunit}
  }%
  {}
 \usepackage{calc} % for calculating minipage widths
@@ -447,6 +454,24 @@
 % Do not put math or special symbols in the title.
 \title{$title$}
 
+
+% split author affiliations for journal and conference layouts
+$if(journal)$
+
+$if(affiliation.author)$
+\author{
+  $for(affiliation.author)$$if(it.last)$and $endif$$it.name$$if(it.member)$, \IEEEmembership{$it.member$}$endif$$sep$, $endfor$
+  $if(affiliation.thanks)$$for(affiliation.thanks)$\thanks{$affiliation.thanks$}$endfor$$endif$
+}
+$else$
+$~$!!! Only 'affiliation.author' syntax is supported for the journal mode. Modify you YAML header accordingly.$~$
+$endif$
+
+\markboth{$journal$$~$, Vol. XX, No. X, XXXXXX 20XX$~$}%
+{$title$}
+
+$else$ % -- end if/journal
+
 % author names and affiliations
 % use a multiple column layout for up to three different
 % affiliations
@@ -563,6 +588,8 @@
 $endif$
 }
 
+$endif$ %% -- end else/journal
+
 % conference papers do not typically use \thanks and this command
 % is locked out in conference mode. If really needed, such as for
 % the acknowledgment of grants, issue a \IEEEoverridecommandlockouts
@@ -586,14 +613,6 @@
 %\IEEEauthorblockA{\IEEEauthorrefmark{4}Tyrell Inc., 123 Replicant Street, Los Angeles, California 90210--4321}}
 
 
-
-
-% use for special paper notices
-%\IEEEspecialpapernotice{(Invited Paper)}
-
-
-
-
 % make the title area
 \maketitle
 
@@ -606,7 +625,7 @@
 % keywords
 $if(keywords)$
 \begin{IEEEkeywords}
-$for(keywords)$$keywords$$sep$; $endfor$
+$for(keywords)$$keywords$$sep$$if(journal)$, $else$; $endif$$endfor$
 \end{IEEEkeywords}
 $endif$
 
@@ -661,5 +680,3 @@
 
 $endfor$
 \end{document}
-
-