Closed gregmacfarlane closed 2 years ago
Thank you @gregmacfarlane, this is a great addition to rticles
for transport people! :)
Just a small suggestion, how about we use knitr::kable()
instead of kableExtra::kbl()
and base::plot()
instead of ggplot()
? This won't require the user to install additional packages for the article to compile.
One other thing that I have spotted, shouldn't [\@reference] omit authors?
Bibliography styles
===================
TRB still wants numbered, unsorted citations. Here are two sample references: [@Feynman1963118; @Dirac1953888].
You can also cite authors, like @Feynman1963118.
Yes, I think removing the dependencies for ggplot and kableExtra is a good idea. Yes, [@author]
should probably omit the authors. I'll have a look at this later.
Hi @gregmacfarlane !
As I am going through opened PR while preparing next rticles, I would like to know the status of this PR. Do you plan to keep working on it following the review ? No hurry, just want to check the status of this PR.
Thank you.
I am working on it today, might be able to knock some things out.
Okay, @cderv ; I think this is now ready to roll. Have another look, and I'm happy to continue the discussion.
This article template is in response to #426
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] 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 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!