Add IOP template #462
Add IOP template #462
Conversation
|
Any changes required to this? |
There was a problem hiding this comment.
Sorry for the delay on this one. I was focus on other packages the past month. I got bakc to rticles yesterday.
Everything seems fine. I made small comments.
Only thing I see if the reference mechanism: currently it is using natbib. Can this template be used with other system supported like biblatex or Pandoc citeproc ?
Compatibility would mean :
- Adding the right variables (
natbibandbiblatexand if clause in the template - Providing an example CSL file for Pandoc citeproc
Most of the templates can use several usually.
Thanks for the contribution ! And sorry again for the delay
There was a problem hiding this comment.
Thanks a lot for taking care of all the changes.
Last thing would be to CSL as a link to not include file within the R Package. We try to bundle as much as possible when the resource is available online and can directly be used.
Having this in YAML would work fine:
csl: https://www.zotero.org/styles/institute-of-physics-numeric
or
csl: https://www.zotero.org/styles/institute-of-physics-harvard
The part you wrote in the document Introduction could explain to download locally the CSL file if needed.
Would that be ok with you to use URL for those file ? This is the last change I would do myself before merging. So I prefer to ask.
Thanks!
|
Sure. Done. |
|
Thank you! |
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_articlebelow is only an example name):[x ] 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].
[x ] Add the
journalname_article()function toR/article.Rif the output format is simple enough, otherwise create a separateR/journalname_article.R.[ x] Document your function using roxygen2. Markdown syntax is supported. Refer to https://roxygen2.r-lib.org/articles/rd-formatting.html for formatting references.
[ 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., whenFILENAMEisplain.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.bibexample, 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.Rby adding a linetest_format("journalname"). We try to keep them in alphabetical order.[ x] Add your name to the list of authors
Authors@Rin 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!