{"id":13666078,"url":"https://github.com/rstudio/rticles","last_synced_at":"2025-05-14T00:04:47.539Z","repository":{"id":15030798,"uuid":"17756613","full_name":"rstudio/rticles","owner":"rstudio","description":"LaTeX Journal Article Templates for R Markdown","archived":false,"fork":false,"pushed_at":"2024-07-21T09:39:07.000Z","size":10185,"stargazers_count":1472,"open_issues_count":67,"forks_count":520,"subscribers_count":42,"default_branch":"main","last_synced_at":"2024-10-29T15:03:24.459Z","etag":null,"topics":["article","journal","paper","r","r-package","rmarkdown"],"latest_commit_sha":null,"homepage":"https://pkgs.rstudio.com/rticles/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"monlouisj/nkgPollBundle","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rstudio.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-14T18:52:20.000Z","updated_at":"2024-10-22T04:46:41.000Z","dependencies_parsed_at":"2023-02-15T12:31:17.678Z","dependency_job_id":"3b39c61b-6f2e-42e9-9552-736f75f6cf56","html_url":"https://github.com/rstudio/rticles","commit_stats":{"total_commits":775,"total_committers":110,"mean_commits":7.045454545454546,"dds":0.7496774193548388,"last_synced_commit":"1aee9911a3c205e2434f6fba0259396526ea59b4"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstudio%2Frticles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstudio%2Frticles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstudio%2Frticles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstudio%2Frticles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rstudio","download_url":"https://codeload.github.com/rstudio/rticles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254043296,"owners_count":22004917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["article","journal","paper","r","r-package","rmarkdown"],"created_at":"2024-08-02T06:00:57.469Z","updated_at":"2025-05-14T00:04:47.513Z","avatar_url":"https://github.com/rstudio.png","language":"TeX","readme":"---\noutput: github_document\neditor_options:\n  markdown:\n    wrap: 72\n    canonical: true\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n\u003c!-- badges: start --\u003e\n\n[![R-CMD-check](https://github.com/rstudio/rticles/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/rticles/actions/workflows/R-CMD-check.yaml)\n[![Downloads from the RStudio CRAN\nmirror](https://cranlogs.r-pkg.org/badges/rticles)](https://cran.r-project.org/package=rticles)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/rticles)](https://CRAN.R-project.org/package=rticles)\n[![Codecov test\ncoverage](https://codecov.io/gh/rstudio/rticles/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/rticles?branch=main)\n\n\u003c!-- badges: end --\u003e\n\n# rticles \u003ca href=\"https://pkgs.rstudio.com/rticles/\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"138\"/\u003e\u003c/a\u003e\n\nThe **rticles** package provides a suite of custom [R\nMarkdown](https://rmarkdown.rstudio.com) LaTeX formats and templates for\nvarious formats. Most of the templates are provided and maintained by\nthe community, and anyone can contribute a new template. See [How to\ncontribute](#how-to-contribute) below.\n\n## Book\n\n\u003ca href=\"https://bookdown.org/yihui/rmarkdown/journals.html\"\u003e\u003cimg src=\"https://bookdown.org/yihui/rmarkdown/images/cover.png\" alt=\"R Markdown: The Definitive Guide\" class=\"book\" height=\"400\"/\u003e\u003c/a\u003e\n\n## Installation\n\nYou can install and use **rticles** from CRAN as follows:\n\n``` r\ninstall.packages(\"rticles\")\n```\n\nIf you wish to install the development version from GitHub (which often\ncontains new article formats), you can do this:\n\n``` r\n# install.packages(\"pak\")\npak::pak(\"rstudio/rticles\")\n```\n\n## Using rticles\n\nTo use **rticles** from RStudio, you can access the templates through\n`File -\u003e New File -\u003e R Markdown`. This will open the dialog box where\nyou can select from one of the available templates:\n\n![New R\nMarkdown](https://bookdown.org/yihui/rmarkdown/images/rticles-templates.png)\n\nIf you are not using RStudio, you'll also need to install\n[Pandoc](https://pandoc.org) following these\n[instructions](https://bookdown.org/yihui/rmarkdown-cookbook/install-pandoc.html).\nThen, use the `rmarkdown::draft()` function to create articles:\n\n``` r\nrmarkdown::draft(\n    \"MyJSSArticle.Rmd\", template = \"jss\", package = \"rticles\"\n)\nrmarkdown::draft(\n    \"MyRJournalArticle\", template = \"rjournal\", package = \"rticles\"\n)\n```\n\nThis will create a folder containing a Rmd file using the corresponding\noutput format and all the assets required by this format.\n\n## Templates\n\nCurrently included templates and their contributors are the following:\n\n| Journal | Contributors | Pull request | Output format |\n|----------------|----------------|--------------------------|----------------|\n| [ACM: Association for Computings Machinery](https://www.acm.org/publications/about-publications) | [\\@ramnathv](https://github.com/ramnathv) | [#8](https://github.com/rstudio/rticles/pull/8) | `acm_article()` |\n| ACS `https://pubs.acs.org` | [\\@yufree](https://github.com/yufree) | [#15](https://github.com/rstudio/rticles/pull/15) | `acs_article()` |\n| [AEA: American Economic Association](https://www.aeaweb.org/journals/templates) | [\\@sboysel](https://github.com/sboysel) | [#86](https://github.com/rstudio/rticles/pull/86) | `aea_articles()` |\n| AGU `https://agupubs.onlinelibrary.wiley.com/` | [\\@eliocamp](https://github.com/eliocamp) | [#199](https://github.com/rstudio/rticles/pull/199) | `agu_article()` |\n| [AJS: Austrian Journal of Statistics](https://www.ajs.or.at) | [\\@matthias-da](https://github.com/matthias-da) | [#437](https://github.com/rstudio/rticles/pull/437) | `ajs_article()` |\n| [AMS: American Meteorological Society](https://www.ametsoc.org/) | [\\@yufree](https://github.com/yufree) | [#96](https://github.com/rstudio/rticles/pull/96) | `ams_article()` |\n| ASA: American Statistical Association `https://www.amstat.org/` |  | [#111](https://github.com/rstudio/rticles/pull/111) | `asa_article()` |\n| [arXiv](https://arxiv.org/) pre-prints based on George Kour's template | [\\@alexpghayes](https://github.com) | [#236](https://github.com/rstudio/rticles/pull/236) | `arxiv_article()` |\n| [Bioinformatics](https://academic.oup.com/bioinformatics) | [\\@ShixiangWang](https://github.com/ShixiangWang) | [#297](https://github.com/rstudio/rticles/pull/297) | `bioinformatics_article()` |\n| [Biometrics](https://biometrics.biometricsociety.org) | [\\@daltonhance](https://github.com/daltonhance) | [#170](https://github.com/rstudio/rticles/pull/170) | `biometrics_article()` |\n| Bulletin de l'AMQ (`https://www.amq.math.ca/bulletin/`) | [\\@desautm](https://github.com/desautm) | [#145](https://github.com/rstudio/rticles/pull/145) | `amq_article()` |\n| [Copernicus Publications](https://publications.copernicus.org) | [\\@nuest](https://github.com/nuest), [\\@RLumSK](https://github.com/RLumSK) | [#172](https://github.com/rstudio/rticles/pull/172), [#342](https://github.com/rstudio/rticles/pull/342) | `copernicus_article()` |\n| [CTeX](https://ctan.org/pkg/ctex) |  |  | `ctex()` |\n| [Elsevier](https://www.elsevier.com) | [\\@cboettig](https://github.com/cboettig), [\\@robjhyndman](https://github.com/robjhyndman) | [#27](https://github.com/rstudio/rticles/pull/27), [#467](https://github.com/rstudio/rticles/pull/467) | `elsevier_article()` |\n| [Frontiers](https://www.frontiersin.org/) | [\\@muschellij2](https://github.com/muschellij2) | [#211](https://github.com/rstudio/rticles/pull/211) | `frontiers_article()` |\n| [Glossa](https://www.glossa-journal.org) | [\\@stefanocoretta](https://github.com/stefanocoretta) | [#361](https://github.com/rstudio/rticles/pull/361) | `glossa_article()` |\n| [IEEE Transaction](https://www.ieee.org/publications_standards/publications/authors/author_templates.html) | [\\@Emaasit](https://github.com/Emaasit), [\\@espinielli](https://github.com/espinielli), [\\@nathanweeks](https://github.com/nathanweeks), [\\@DunLug](https://github.com/DunLug) | [#97](https://github.com/rstudio/rticles/pull/97), [#169](https://github.com/rstudio/rticles/pull/169), [#227](https://github.com/rstudio/rticles/pull/227), [#263](https://github.com/rstudio/rticles/pull/263), [#264](https://github.com/rstudio/rticles/pull/264), [#265](https://github.com/rstudio/rticles/pull/265) | `ieee_article()` |\n| [IMS: Institute of Mathematical Statistics](https://imstat.org/) [AoAS: Annals of Applied Statistics](https://imstat.org/journals-and-publications/annals-of-applied-statistics/) | [\\@auzaheta](https://github.com/auzaheta) | [#372](https://github.com/rstudio/rticles/pull/372) | `ims_article()` |\n| [INFORMS: Institute for Operations Research and the Management Sciences](https://www.informs.org/) | [\\@robjhyndman](https://github.com/robjhyndman) | [#460](https://github.com/rstudio/rticles/pull/460) | `informs_article()` |\n| [ISBA: International Society for Bayesian Analysis](https://bayesian.org/) | [\\@dmi3nko](https://github.com/dmi3kno) | [#461](https://github.com/rstudio/rticles/pull/461) | `isba_article()` |\n| IOP: Institute of Physics (`https://iopscience.iop.org`) | [\\@robjhyndman](https://github.com/robjhyndman) | [#462](https://github.com/rstudio/rticles/pull/462) | `iop_article()` |\n| [JASA: Journal of the Acoustical Society of America](https://pubs.aip.org/asa/jasa) | [\\@stefanocoretta](https://github.com/stefanocoretta) | [#364](https://github.com/rstudio/rticles/pull/364) | `jasa_article()` |\n| [Journal of Educational Data Mining](https://jedm.educationaldatamining.org/index.php/JEDM/about/submissions) journal submissions | [\\@jooyoungseo](https://github.com/jooyoungseo) | [#251](https://github.com/rstudio/rticles/pull/251) | `jedm_article()` |\n| [JOSS: Journal of Open Source Software](https://joss.theoj.org/) [JOSE: Journal of Open Source Education](https://jose.theoj.org/) | [\\@noamross](https://github.com/noamross) | [#229](https://github.com/rstudio/rticles/pull/229) | `joss_article()` |\n| [JSS: Journal of Statistical Software](https://www.jstatsoft.org/index) |  |  | `jss_article()` |\n| [LIPIcs](https://www.dagstuhl.de/en/publishing/series/details/lipics) | [\\@nuest](https://github.com/nuest) | [#288](https://github.com/rstudio/rticles/pull/288) | `lipics_article()` |\n| [MDPI](https://www.mdpi.com) | [\\@dleutnant](https://github.com/dleutnant), [\\@mps9506](https://github.com/mps9506) | [#147](https://github.com/rstudio/rticles/pull/147), [#515](https://github.com/rstudio/rticles/pull/515) | `mdpi_article()` |\n| [MNRAS: Monthly Notices of the Royal Astronomical Society](https://academic.oup.com/mnras) | [\\@oleskiewicz](https://github.com/oleskiewicz) | [#175](https://github.com/rstudio/rticles/pull/175) | `mnras_article()` |\n| [OUP: Oxford University Press](https://academic.oup.com/pages/for-authors/journals/preparing-and-submitting-your-manuscript) | [\\@dmkaplan](https://github.com/dmkaplan) | [#284](https://github.com/rstudio/rticles/pull/284) | `oup_articles()` |\n| [PeerJ: Journal of Life and Environmental Sciences](https://peerj.com) | [\\@zkamvar](https://github.com/zkamvar) | [#127](https://github.com/rstudio/rticles/pull/127) | `peerj_article()` |\n| [PiHPh: Papers in Historical Phonology](https://journals.ed.ac.uk/pihph/about/submissions) | [\\@stefanocoretta](https://github.com/stefanocoretta) | [#362](https://github.com/rstudio/rticles/pull/362) | `pihph_article()` |\n| [PLOS](https://plos.org/#journals) | [\\@sjmgarnier](https://github.com/sjmgarnier) | [#12](https://github.com/rstudio/rticles/pull/12) | `plos_article()` |\n| PNAS: Proceedings of the National Academy of Sciences (`https://www.pnas.org/`) | [\\@cboettig](https://github.com/cboettig) | [#72](https://github.com/rstudio/rticles/pull/72) | `pnas_article()` |\n| RSOS: Royal Society Open Science `https://www.royalsocietypublishing.org/journal/rsos` | [\\@ThierryO](https://github.com/ThierryO) | [#135](https://github.com/rstudio/rticles/pull/135) | `rsos_article()` |\n| [RSS: Royal Statistical Society](https://rss.org.uk/) | [\\@carlganz](https://github.com/carlganz) | [#110](https://github.com/rstudio/rticles/pull/110) | `rss_article()` |\n| [Sage](https://uk.sagepub.com/en-gb/eur/manuscript-submission-guidelines) | [\\@oguzhanogreden](https://github.com/oguzhanogreden) | [#181](https://github.com/rstudio/rticles/pull/181) | `sage_article()` |\n| [Springer](https://www.springernature.com/gp/authors/campaigns/latex-author-support) | [\\@strakaps](https://github.com/strakaps) | [#164](https://github.com/rstudio/rticles/pull/164) | `springer_article()` |\n| [Springer Lecture Notes in Computer Science (LCNS)](https://www.springer.com/gp/computer-science/lncs/conference-proceedings-guidelines) | [\\@eliocamp](https://github.com/eliocamp/) | [#445](https://github.com/rstudio/rticles/issues/445) | `lncs_article()` |\n| SIM: Statistics in Medicine `https://onlinelibrary.wiley.com/journal/10970258)` | [\\@ellessenne](https://github.com/ellessenne) | [#231](https://github.com/rstudio/rticles/pull/231) | `sim_article()` |\n| Taylor \u0026 Francis (`https://www.tandfonline.com/`) | [\\@dleutnant](https://github.com/dleutnant) | [#218](https://github.com/rstudio/rticles/pull/218) | `tf_article()` |\n| [The R Journal](https://journal.r-project.org/) |  |  | Use [rjtools](https://rjournal.github.io/rjtools/) package now. `rjournal_article()` is deprecated. |\n| [TRB](https://trb.secure-platform.com/a/page/TRBPaperReview) | [\\@gregmacfarlane](https://github.com/gregmacfarlane) | [#427](https://github.com/rstudio/rticles/pull/427) | `trb_article()` |\n| [Wellcome Open Research](https://wellcomeopenresearch.org) | [\\@arnold-c](https://github.com/arnold-c) | [#436](https://github.com/rstudio/rticles/pull/436) | `wellcomeor_article()` |\n\nYou can also get the list of available journal names with\n`rticles::journals()`.\n\n```{r}\nrticles::journals()\n```\n\nThose are the values to use within `rmarkdown::draft()`.\n\nUnder the hood, LaTeX templates are used to ensure that documents\nconform precisely to submission standards. At the same time, composition\nand formatting can be done using lightweight\n[markdown](https://rmarkdown.rstudio.com/authoring_basics.html) syntax,\nand R code and its output can be seamlessly included using\n[knitr](https://yihui.org/knitr/).\n\n## Getting help\n\nThere are two main places to get help:\n\n1.  The [RStudio\n    community](https://forum.posit.co/tags/c/R-Markdown/10/rticles) is a\n    friendly place to ask any questions about **rticles**. Be sure to\n    use the `rticles` tag.\n\n2.  [Stack Overflow](https://stackoverflow.com/questions/tagged/rticles)\n    is a great source of answers to common **bookdown** questions. Use\n    the tags\n    [`[r][rticles]`](https://stackoverflow.com/questions/tagged/rticles+r)\n    if you ask a question.\n\n## Code of Conduct\n\nPlease note that the rticles project is released with a [Contributor\nCode of Conduct](https://pkgs.rstudio.com/rticles/CODE_OF_CONDUCT.html).\nBy contributing to this project, you agree to abide by its terms.\n\n## How to contribute? {#how-to-contribute}\n\nMost of the templates are contributed directly by the users in the\ncommunity. If you want **rticles** to offer a new journal format, you\ncan contribute by the following way.\n\n### Suggest an idea for new format opening an issue.\n\nYou may not feel confident enough or may not have time to contribute a\nnew format. By opening a new issue, you can share the idea for this\nformat, and see if someone in the community can help on it.\\\nThis is not the best way to quickly get your format included but at\nleast it is a great way to see if others are interested too.\n\nTo see the existing suggested formats, just filter issues with the [help\nwanted\n:heart:](https://github.com/rstudio/rticles/labels/help%20wanted%20%3Aheart%3A)\nlabel. You can then add a :+1: or help to add the template :wink:.\n\n### Contribute a new template format opening a pull request.\n\nTo contribute a new format, you need to open a new pull request (PR).\nWhen opening the PR, you'll see the [PR\ntemplate](https://pkgs.rstudio.com/rticles/PULL_REQUEST_TEMPLATE.html)\nexplaining how to proceed and what is important to check. Please follow\nit.\\\nEven if you are just starting or you are not finished, you share your\nwork by creating a [draft\nPR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests).\nIt is a great way to let us know that you are still working on it (like\n[these opened\nones](https://github.com/rstudio/rticles/pulls?q=is%3Apr+draft%3Atrue+)),\nand it is also a great way to ask for help from the community.\\\nWhen you are ready, you can submit the PR for review, and we will\niterate until it is merged.\n\n#### Technical resources helpful to contribute a template\n\nThe best way to get started is to look at the previous examples of\nsubmitted PR. You'll find links to them in the table [above](#overview).\n\nAll the `rticles` format are build similarly by providing a new pandoc\ntex template to replace the default one. You'll learn more about pandoc\ntemplates in these places:\n\n-   [R Markdown\n    Cookbook](https://bookdown.org/yihui/rmarkdown-cookbook/latex-template.html)\n-   [The Pandoc manual](https://pandoc.org/MANUAL.html#templates)\n\nYou can study [existing\nformats](https://github.com/rstudio/rticles/tree/main/inst/rmarkdown/templates)\nto see how all this works.\n","funding_links":[],"categories":["TeX","Rmarkdown Templates"],"sub_categories":["Paper"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstudio%2Frticles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frstudio%2Frticles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstudio%2Frticles/lists"}