Add Science Template

[christopherkenny]

How to contribute a new output format ?

To contribute a new article template to this package, please make sure you have done the following things (note that journalname_article below is only an example name):

• This project uses a Contributor Licence Agreement (CLA) that you'll be asked to sign when opening a PR. This is required for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). We use a tool called CLA assistant for that.
  You could also, unless you have done it in any other RStudio's projects before, sign the individual or corporate contributor agreement. You can send the signed copy to [email protected].

• Add the journalname_article() function to R/article.R if the output format is simple enough, otherwise create a separate R/journalname_article.R.

• Document your function using roxygen2. Markdown syntax is supported. Refer to https://roxygen2.r-lib.org/articles/rd-formatting.html for formatting references.

• Add the Pandoc LaTeX template inst/rmarkdown/templates/journalname/resources/template.tex.

• Add a skeleton article inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd.

• Add a description of the template inst/rmarkdown/templates/journalname/template.yaml.

• Please include the document class file (*.cls) if needed, but please do not include standard LaTeX packages (*.sty) that can be downloaded from CTAN. If you are using TinyTeX or TeX Live, you can verify if a package is available on CTAN via tinytex::parse_packages(files = "FILENAME"") (e.g., when FILENAME is plain.bst, it should return "bibtex", which means this file is from a standard CTAN package). Please keep the number of new files absolutely minimal (e.g., do not include PDF output files), and also make examples minimal (e.g., if you need a .bib example, try to only leave one or two bibliography entries in it, and don't include too many items in it without using all of them).

• Update Rd and namespace (could be done by devtools::document()).

• Update NEWS.

• Update README with a link to the newly supported journal. Please add your Github username and the full name of the journal (follow other examples in the list).

• Add a test to tests/testit/test-formats.R by adding a line test_format("journalname"). We try to keep them in alphabetical order.

• Add your name to the list of authors Authors@R in DESCRIPTION. You don't need to bump the package version in DESCRIPTION.

Lastly, please try your best to do only one thing per pull request (e.g., if you want to add two output formats, do them in two separate pull requests), and refrain from making cosmetic changes in the code base: https://yihui.name/en/2018/02/bite-sized-pull-requests/

Thank you!

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
0 out of 2 committers have signed the CLA.

❌ christopherkenny
❌ kuriwaki
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[cderv]

Thanks @christopherkenny

Sorry for the delay on this one. We were focusing on other project and rticles was a bit on the side. It will took me more time than usual to review this. It seems the science template is quite complex but you manage to come around.

Did you already use it for article and to submit ?
I am just trying to evaluate how deep of a review and check I need to do here. You document is rendering to PDF and seems fine, I just don't know about Science journal.

@jcolomb as you opened #320 you may be interested to give this format a try maybe.

[christopherkenny]

Hi @cderv. No worries. Love the other projects going on at RStudio.

I've used it before for submission. It worked fine and there were no real complaints from the editor side. It's a bit of a weird template, as you saw. Happy to run any tests locally that might help you.

[cderv]

Sorry for the delay on this. Hopefully you'll have time to consider the review and work with me on this one.

Main question: Am I that late on this that we need to consider updating the template and resources from https://www.science.org/content/page/preparing-manuscripts-using-latex ?

Thank you

[cderv]

I understand the purpose here is to have all the section unnumbered right ?

Just a reminder this can be done in Markdown with

# section {.unnumbered}

and this could be made a default by using a Lua filter to add the class on each header that needs it.

But I guess tex post processing is working well too

[cderv]

It seems the last template available at https://www.science.org/content/page/preparing-manuscripts-using-latex
does not have this part anymore. I wonder if we should update

[cderv]

This is external .tex file that you wan't to compile to other PDF while rendering this one, right ?

No Rmd file to render() using another template ?

[cderv]

I think some conditional need to be made around natbib or biblatex. or the format function should only only natbib citation processing.

This is usual among other format if you look for example.

Even using csl file with Pandoc's citeproc won't work for this template as this will still insert those command I think.

[cderv]

Is there a reason to keep this all latex and not use Markdown list and other syntax ?

Just curious

[christopherkenny]

Hi @cderv, it does look like they've changed the template in the last year or so, but it's more the same than not. I can work through your comments on it and update to the newer template.