Closed auzaheta closed 3 years ago
Thanks a lot for the suggestions to improve the template and the detailed review.
The template is generic for all the journals they have; being precise, all templates use the same style file. I checked the five journals directly related to IMS Journals and publications, and I added a comment in the skeleton indicating the acronym of the journals and additional variable that should be used for some of them. I didn't find a way of adding an example of this variable's type of content that allows an easy way of uncommenting it.
In summary, it works for these five journals. All of them have the same tex template. I tried to emphasize the annals of applied statistics in the news and the readme because I think it is the one most of us could use.
This template could be used for other journals beyond these five (also IMS). It would require developing the function with the argument with an indication of the journal and create independent skeletons (as you suggested). However, this is beyond what I know how to do and what I will need soon. Happy to learn how to do it in any case.
I tried to follow your recommendation to have more Rmarkdown syntax in the skeleton.
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):[X] 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.
[X] Add the
journalname_article()
function toR/article.R
if the output format is simple enough, otherwise create a separateR/journalname_article.R
.[X] Add the Pandoc LaTeX template
inst/rmarkdown/templates/journalname/resources/template.tex
.[X] Add a skeleton article
inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd
.[X] Add a description of the template
inst/rmarkdown/templates/journalname/template.yaml
.[X] 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 viatinytex::parse_packages(files = "FILENAME"")
(e.g., whenFILENAME
isplain.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).[X] Update Rd and namespace (could be done by
devtools::document()
).[X] Update NEWS.
[X] 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).
[X] Add a test to
tests/testit/test-formats.R
by adding a linetest_format("journalname")
. We try to keep them in alphabetical order.[X] 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!