yanxg / rticles Goto Github PK

You can install and use rticles from CRAN as follows:

install.packages("rticles")

If you wish to install the development version from GitHub (which often contains new article formats), you can do this:

remotes::install_github("rstudio/rticles")

The rticles package provides a suite of custom R Markdown LaTeX formats and templates for various formats. Most of the templates are provided and maintained by the community, and anyone can contribute a new template. See How to contribute below.

Currently included templates and their contributors are the following:

You can also get the list of available journal names with rticles::journals().

Under the hood, LaTeX templates are used to ensure that documents conform precisely to submission standards. At the same time, composition and formatting can be done using lightweight markdown syntax, and R code and its output can be seamlessly included using knitr.

Using rticles requires the prerequisites described below. You can get most of these automatically by installing the latest release of RStudio (instructions for using rticles without RStudio are also provided).

To use rticles from RStudio:

1. Install the latest RStudio.

2. Install the rticles package.

3. Use the New R Markdown dialog to create an article from one of the templates:

   

1. Install Pandoc using the instructions for your platform.

2. Install the rticles packages.

3. Use the rmarkdown::draft() function to create articles:

   rmarkdown::draft("MyJSSArticle.Rmd", template = "jss", package = "rticles")
   rmarkdown::draft("MyRJournalArticle", template = "rjournal", package = "rticles")

   This will create a folder containing a Rmd file using the corresponding output format and all the assets required by this format.

Most of the templates are contributed directly by the users in the community. If you want rticles to offer a new journal format, you can contribute by the following way.

You may not feel confident enough or may not have time to contribute a new format. By opening a new issue, you can share the idea for this format, and see if someone in the community can help on it.
This is not the best way to quickly get your format included but at least it is a great way to see if others are insterested too.

To see the existing suggested formats, just filter issues with the help wanted label. You can then add a 👍 or help to add the template 😉.

To contribute a new format, you need to open a new pull request (PR). When opening the PR, you'll see the PR template explaining how to proceed and what is important to check. Please follow it.
Even if you are just starting or you are not finished, you share your work by creating a draft PR. It is a great way to let us know that you are still working on it (like these opened ones), and it is also a great way to ask for help from the community.
When you are ready, you can submit the PR for review, and we will iterate until it is merged.

The best way to get started is to look at the previous examples of submitted PR. You'll find links to them in the table above.

All the rticles format are build similarly by providing a new pandoc tex template to replace the default one. You'll learn more about pandoc templates in these places:

• R Markdown Cookbook
• The Pandoc manual

You can study existing formats to see how all this works.