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

Adding INFORMS template #460

Merged
merged 20 commits into from
Jan 3, 2022
Merged

Adding INFORMS template #460

merged 20 commits into from
Jan 3, 2022

Conversation

robjhyndman
Copy link
Contributor

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_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 [email protected].

  • [x ] Add the journalname_article() function to R/article.R if the output format is simple enough, otherwise create a separate R/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 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).

  • [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 line test_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!

@CLAassistant
Copy link

CLAassistant commented Dec 23, 2021

CLA assistant check
All committers have signed the CLA.

@robjhyndman robjhyndman mentioned this pull request Dec 23, 2021
3 tasks
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 a lot !

A few comments below.

Also I see this in the output
image

It does not seem to come from the template. Is this expected in all produced articles ?
I am just asking out of curiosity.

NEWS.md Outdated Show resolved Hide resolved
tests/testit/test-formats.R Outdated Show resolved Hide resolved
inst/rmarkdown/templates/informs/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
R/article.R Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
inst/rmarkdown/templates/informs/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/informs/resources/template.tex Outdated Show resolved Hide resolved
@robjhyndman
Copy link
Contributor Author

All issues addressed in the latest commit a225596

The red text in the output is hard-coded into the informs.cls file.

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.

Just a last comment that I could include before merging - we need a requirement on Pandoc version due to usage of special feature in the template.

Also, can you put the change related to IOP article work in another PR ? Another branch from master ?

Thank you.

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 make a few more tweaks then merge !

And Happy new year @robjhyndman !

@cderv cderv merged commit 9cfda82 into rstudio:master Jan 3, 2022
@cderv cderv linked an issue Feb 11, 2022 that may be closed by this pull request
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 4, 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.

Add INFORMS styles
3 participants