rticles 0.22 Unreleased

rticles 0.21 2021-09-11

NEW FEATURES

MAJOR CHANGES

  • Since rticles 0.15, per requirement with R Journal, rjournal_article() uses knitr::purl() to produce a R file with the code from the Rmd file. Last version eagerly overwrites any existing R file with the same name as the purled file. From now on, if a .R already exists with the name of the output, it won’t be overwritten anymore, and not purled file will be outputted. This prevent issue with users maintaining themselves their own R file to accompany the article. A warning is issued to remind of deleting the existing R file is one want to use the purled R file (thanks, @Enchufa2, #433).

  • Update Copernicus Publications template to version 6.3 from 2021-07-08 (thanks, @RLumSK, #432).

MINOR CHANGES

  • All templates have now the $highlighting-macros$ variables required for Pandoc highlighting (#435).

  • Template for tf_article() gains a classoption variable (thanks, @statzhero, #434).

  • Add the fenced div with id #refs in frontiers_article() skeleton to place the reference section in the correct expected place (thanks, @graysonwhite, #423).

  • bioinformatics_article() now separates manuscript_type (e.g., Applications note, Original article) and subject_section (e.g. Genome analysis, Phylogenetics) in template and skeleton (thanks, @stephenturner, #415)

  • For contributors to this package: Markdown syntax is now used with roxygen2 to document R functions. Refer to formating rules on roxygen2 website

BUG FIXES

rticles 0.20 2021-06-23

  • lipics_article() skeleton now sets option bookdown.theorem.preamble to FALSE to work with bookdown::pdf_book() and avoid conflicts in theorem environment definition. This requires bookdown 0.23 or higher (#392).

  • oup_article() template now largely compatible to that of elsevier_article() (thanks, @dmkaplan2000, #403)

  • elsevier_article() now supports biblio-style Pandoc’s variable to set the natbib bibliography style in YAML header (thanks, @gregmacfarlane, #402).

  • Fix an issue with rjournal_article(). The .R file in output is now correctly overwritten on a new render if it existed from a previous render (thanks, @apreshill, #394).

  • Update Copernicus Publications template to comply with editor’s guidelines following a manuscript bounce back during the typesetting step. Copernicus does not allow to add any \usepackage command as they all are included in copernicus.cls for supported LaTeX packages. This is leading to breaking changes with existing template - please follow the advice below.

    • algorithms: true cannot be used anymore and as no more effect. \usepackage{algorithmic} and \usepackage{algorithm} has been removed from the template as the command are already done in copernicus.cls. Please, make sure algorithms and algorithmcx are installed.
    • Additionally, the template gained support for the highlight parameter of [rmarkdown::pdf_document()] to enable or disable syntax highlighting with Pandoc. To comply with the above guideline by Copernicus, it is disabled by default (highlight: NULL) to prevent Pandoc adding any more packages required for its highlighting. Syntax highlighting can be reactivating by using highlight: "default" in the YAML header as this can be desirable before submitting for typesetting. (thanks, @RLumSK, @nuest, #391).
  • Fix issue with Pandoc’s citation processing by updating all templates with last relevant changes from Pandoc’s default template (thanks, @BlackEdder, @dahrens, #390)

  • remove warning in joss_article() about citation_package (thanks, @llrs, #389).

  • fix an issue with rjournal_article() template to insert newline in author’s block only if a field exist (thanks, @huizezhang-sherry, #387)

rticles 0.19 2021-03-04

  • Update Copernicus Publications template to version 6.2 from 2021-01-15 (thanks, @RLumSK, #366).

  • Add article template pihph_article() for the Papers in Historical Phonology (PiHPh) (thanks, @stefanocoretta, #362).

  • Add article template ims_article() for Institute of Mathematical Statistics Journals, e.g., Annals of Applied Statistics (thanks, @auzaheta, #372)

rticles 0.18 2021-01-06

  • springer_article() now uses the yaml variable biblio-style to set bibliography style instead of bibstyle. (@eliocamp, #358)

  • Fixes a bug when rendering arxiv_article() with recent version of TeX Live by adding \usepackage{lmodern} to the template. (#thanks, @slemonide, #343)

  • arxiv_article() now supports header-includes and biblio-style to use in the YAML header in order to customize its template. Default bibliography style is still unsrt if not set as before. (thanks, @eliocamp, #356).

  • Update jss.cls to version 3.2 (#329).

  • Options can now be passed to hyperref packages using header-includes and \PassOptionsToPackage in the AEA template (thanks, @nurfatimaj, #334)

  • Update Copernicus Publications template to version 6.1. This is includes a final fix for the LaTeX problem sanitized with the last rticles update (thanks, @RLumSK, #331).

  • Update all templates regarding CSLReference environment following changes in Pandoc’s default template.

  • Add article template jasa_article() for the Journal of the Acoustical Society of America (JASA) (thanks, @stefanocoretta, #364)

rticles 0.17 2020-11-01

  • Fixes arxiv_article() template when adding graphics from code chunks (thanks, @Athanasiamo, #332).

  • Fixes ams_article() template regarding authors insertion (thanks, @ConorIA, #340).

  • Update Copernicus Publications template to version 6.0 and sanitize and issue that caused pdftex from hanging (thanks, @RLumSK, #331).

  • Add CSLReferences environment to support new Pandoc 2.11 citation processing (#335).

  • Add article template lipics_article() for Leibniz International Proceedings in Informatics (LIPIcs) (thanks, @nuest, #288).

rticles 0.16 2020-09-22

  • Fixed ctex_article() to correctly use the default Pandoc template as intended in the PR #307, which introduced the bug #322 (thanks, @baketbek @cderv #323).

  • The minimal version of knitr required is 1.30 now.

rticles 0.15 2020-08-26

  • Added a new journals() function to list all available journal names in this package (#318).

  • Template directory in package’s rmarkdown/templates directory has been renamed from journalname_article to journalname. To create a new document using rmarkdown::draft, only the journalname should be provided, i.e., rmarkdown::draft("MyArticle.Rmd", template = "rjournal", package = "rticles") (#316).

  • Improved the rjournal_article() format : .tex, .R, and PDF files with correct names are generated to match the author’s guidelines, two affiliations is now supported for authors, the last author is separated by and when multiple authors are present, and the documentation has been improved on the help page ?rticles::rjournal_article and in the skeleton document (thanks, @RLumSK, #286).

  • Added a author.affiliation2 field in jss_article() template to provide another affiliation to be used in the adress field in place of author.affiliation. This allow differently formatted affiliation for example (thanks, @aldomann, #291).

  • Improved the jss_article() format: Short titles can now be provided to headers to escape code/math in section titles, the continuation prompt has been corrected (from R+ to +), and the skeleton document has been updated accordingly (thanks, @statibk #254, @Freguglia #294).

  • Fixed elsevier_article() template so that chunk option out.width can be set (thanks, @EddieItelman, #300).

  • Fixed pnas_journal() skeleton to show how correctly add corresponding_author and equal_author (thanks, @EddieItelman, #299).

  • Added article template for journal Bioinformatics (thanks, @ShixiangWang, #297).

  • Update Copernicus Publications template to version 5.8 (thanks, @nuest, #274).

  • Fixed issue with multi-line authors on JSS template when using \AND, which was firstly implemented in b740b19b90cd6f7afe2cd7d66456c9efa0bb4cdf (thanks, @aldomann, #292).

  • Added the missing support for header-includes to the Biometrics template (thanks, @haozhu233, #296).

  • Added support for George Kour’s arXiv preprint format (thanks, @alexpghayes, #236).

  • Update to OUP format for knitr::kable table generation and optionally placing floats at end of document (thanks, @dmkaplan2000, #279).

  • Update to OUP format to use pandoc-citeproc by default for citations (thanks, @dmkaplan2000, #289).

  • Deleted the LaTeX template of the rticles::ctex format. This format will use Pandoc’s built-in template instead, which works well with the LaTeX package ctex (thanks, @XiangyunHuang, #307).

  • Added the output format rticles::ctex_article as an alias to rticles::ctex, to be consistent with the names of other *_article formats.

rticles 0.14 2020-02-05

  • Added custom author ordering for the IEEE template (thanks, @DunLug, #263).

  • Added a multi-line authoring option in the IEEE template (thanks, @DunLug, #264).

  • Added the citation_sorting YAML option to change the biblatex’s sorting option in ieee_article() output (thanks, @DunLug, #265).

  • mnras.cls was removed from this package because it exists on CTAN.

  • Added Oxford University Press (OUP) template (thanks, @dmkaplan2000, #271).

rticles 0.13 2019-12-19

  • Added the cslreferences environment to all templates (thanks, @bbauzile, #260).

  • Updated the template for elsevier_article() to allow for two authors to share the same footnote (e.g. “these authors made equal contributions”) and updated the corresponding skeleton to demonstrate how to use a shared footnote (thanks, @salauer, #255).

  • Fixed header includes for rjournal_article() (thanks, @agila5 #257, @rcannood #261).

  • Add support for bibliography styles on the Springer template (thanks, @swhaat, #262).

rticles 0.12 2019-11-12

rticles 0.11 2019-10-01

  • Added the Journal of Open Source Software (and Education) template (@noamross, #229).

  • Tweaked the tf_article template to avoid using absolute full paths for figures in the “Figures” section (@jooyoungseo, #246).

rticles 0.10 2019-08-21

rticles 0.9 2019-07-12

rticles 0.8 2019-05-14

  • Added the Taylor & Francis journal template (@dleutnant, #218).

  • The top-level option biblio-files in the YAML frontmatter was changed to bibliography in the elsevier_article() template (@JohannesFriedrich, #222).

  • Added header option correspongdingauthors to configure multiple corresponding authors for Copernicus Publications (@nuest, #221).

  • Updated the template for MDPI to 02/2019 (@dleutnant, #203).

rticles 0.7 2019-03-16

rticles 0.6 2018-10-09

rticles 0.5 2018-07-06

  • Added the template for the IEEE Transaction Journals (thanks, @Emaasit, #97).

  • Added the PeerJ format (thanks, @zkamvar, #127).

  • Added a template for the Royal Society Open Science Journal (thanks, @ThierryO, #135).

  • Added a template for Bulletin de l’AMQ (thanks, @desautm, #145).

  • Added the MDPI journal template (thanks, @dleutnant, #147).

  • Added the Springer Journal Article template (thanks, @strakaps, #164).

  • Added the template for MNRAS (Monthly Notices of the Royal Astronomical Society) articles (thanks, @oleskiewicz, #175).

  • Fixed #6, #10, #49, #132, and #149: dollar signs and other special LaTeX characters such as ^ can be used in code chunks in JSS and R Journal articles now, but Pandoc 2.x will be required (you can use the Preview version of RStudio if you do not want to install Pandoc separately).

  • Fixed #9: special characters such as spaces and underscores can be used in Rmd filenames for R Journal articles now.

  • Fixed #71: bibliography is supported for The R Journal articles now.

  • Supports breaking the JSS author list into multiple lines; see #100 for details.

rticles 0.4.1 2017-05-16

  • Add Royal Society Open Science journal template

  • Add Institute of Electrical and Electronics Engineers (IEEE) IEEEtrans template for Conferences

rticles 0.2 2016-04-24

  • Add American Chemical Society (ACS) template

  • Allow changing of documentclass and classoption for JSS articles

  • Support bibliography for JSS articles (#63)

  • Add tightlist macro to Elsevier skeleton

  • Add address and footnote examples to Elsevier skeleton

  • Fix preamble variable name in R Journal template

rticles 0.1 2016-01-05

  • Initial release to CRAN