[WIP] First attempt at arXiv template by alexpghayes · Pull Request #236 · rstudio/rticles (original) (raw)
Taking a crack #235 but running into issues with the template.
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):
- Unless you have done it in any other RStudio's projects before, please sign the individual or corporate contributor agreement for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). You can send the signed copy to jj@rstudio.com.
- Add the
journalname_article()
function toR/article.R
if the output format is simple enough, otherwise create a separateR/journalname_article.R
. - Add the Pandoc LaTeX template
inst/rmarkdown/templates/journalname_article/resources/template.tex
. - Add a skeleton article
inst/rmarkdown/templates/journalname_article/skeleton/skeleton.Rmd
. - Add a description of the template
inst/rmarkdown/templates/journalname_article/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. Please keep the number of new files absolutely minimal, 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 one hundred items in it without using all of them).
NOTE: I don't think arxiv
is on CTAN from a cursory search, but my LaTeX awareness isn't high enough to confirm this. For the time being I'm going operate under the assumption that arxiv.sty
is necessary and belongs where it is.
- Update Rd and namespace (could be done by
devtools::document()
). - Update NEWS.
- Update README with a link to the newly supported journal.
- Add a test to
tests/testit/test-formats.R
. - Add your name to the list of authors
Authors@R
in DESCRIPTION. You don't need to bump the package version in DESCRIPTION.