Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ISBA template (Bayesian Analysis) #461

Merged
merged 24 commits into from
Feb 1, 2022
Merged

Add ISBA template (Bayesian Analysis) #461

merged 24 commits into from
Feb 1, 2022

Conversation

dmi3kno
Copy link
Contributor

@dmi3kno dmi3kno commented Jan 3, 2022

ISBA format (Bayesian Analysis)

I added and checked the following:

  • 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 to R/article.R if the output format is simple enough, otherwise create a separate R/journalname_article.R.

  • Document your function using roxygen2. Markdown syntax is supported. Refer to https://roxygen2.r-lib.org/articles/rd-formatting.html for formatting references.

  • Add the Pandoc LaTeX template inst/rmarkdown/templates/journalname/resources/template.tex.

  • Add a skeleton article inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd.

  • 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 via tinytex::parse_packages(files = "FILENAME"") (e.g., when FILENAME is plain.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).

  • 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).

  • Add a test to tests/testit/test-formats.R by adding a line test_format("journalname"). We try to keep them in alphabetical order.

  • 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!

@CLAassistant
Copy link

CLAassistant commented Jan 3, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

Thanks for the contribution. I have put my comment below. Happy to discuss the changes.

inst/rmarkdown/templates/isba/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/isba/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/isba/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/isba/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
R/article.R Outdated Show resolved Hide resolved
inst/rmarkdown/templates/isba/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
inst/rmarkdown/templates/isba/template.yaml Outdated Show resolved Hide resolved
@cderv
Copy link
Collaborator

cderv commented Feb 1, 2022

You can do this like in informs_article() that I shared in the comment #461 (comment)

@dmi3kno dmi3kno requested a review from cderv February 1, 2022 16:07
Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I'll commit the few small tweaks I have seen and merge. Thank you !

NEWS.md Outdated Show resolved Hide resolved
tests/testit/test-formats.R Outdated Show resolved Hide resolved
R/article.R Outdated Show resolved Hide resolved
R/article.R Outdated Show resolved Hide resolved
R/article.R Outdated Show resolved Hide resolved
@cderv cderv merged commit da49ab9 into rstudio:master Feb 1, 2022
@dmi3kno
Copy link
Contributor Author

dmi3kno commented Mar 3, 2022

Could you please quickly correct the readme file. In the table the name of the function is isba_article() not informs_article()

@cderv
Copy link
Collaborator

cderv commented Mar 3, 2022

It is done. Thanks for seeing this!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants