Format for AAAS Science Journal
Hi! @cderv
This is in reference to issue #320 . I have tried to do what I can. I do have some doubts which are given in /templates/science/resources/doubts.md. I have added my doubts in detail to the individual things below.
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 toR/article.Rif the output format is simple enough, otherwise create a separateR/journalname_article.R.
Have done this bit. I am not sure how to word the function. Is this the function that is responsible for generating the output. I am not clearly understanding how the data is flowing through this.
- [ ] Add the Pandoc LaTeX template
inst/rmarkdown/templates/journalname/resources/template.tex.
Added. I also included the original template from the Science website
- [ ] Add a skeleton article
inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd.
Added. Might update this as rest changes.
-
[X] 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 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). -
[ ] 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).
Not yet done.
- [ ] Add a test to
tests/testit/test-formats.Rby adding a linetest_format("journalname"). We try to keep them in alphabetical order.
Not yet done. Will do once the template etc is finalised.
- [ ] Add your name to the list of authors
Authors@Rin DESCRIPTION. You don't need to bump the package version in DESCRIPTION.
Not yet done.
Thank you so much for any guidance to improve this and help me close this PR.
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.
1 out of 3 committers have signed the CLA.
:white_check_mark: cderv
:x: Sasank
:x: sasank89
Sasank seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.
Hi @sasank89 !
Just a friendly ping. Are you planning to keep working on this branch to add the AAAS template ?
Just in order to know what are the plan on this one.
Thanks.
Hi @sasank89,
I have merge master branch into this PR so that it is easier to start on better grounds next time you'll work on this.
Do you plan to continue this PR any time soon ?
No rush, just to know the status on this.
Hi @cderv ,
So sorry I dropped off for a few months. Unfortunately, I did not get much time to work on this the past few months. I do want to work on it and complete it. Hopefully, I will be able to do more in the coming months.
Hi @sasank89,
No problem. Take your time on it, I am in no hurry. I'll just continue to ping once in a while to get status update so that I know if this becomes stale or not.
Happy to help in any way, so please do ping me for anything that I could help with to add this article format.
Thanks for your time and work on this !
@sasank89 Just to share that there is another try at this in #486