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 pihph_article() #362

Merged
merged 29 commits into from
Feb 9, 2021
Merged

add pihph_article() #362

merged 29 commits into from
Feb 9, 2021

Conversation

stefanocoretta
Copy link
Contributor

The pull request adds pihph_article() for articles of Papers in Historical Phonology (PiHPh).

✅ R CMD check succeeded.

✅ Pull request check list:

  • Unless you have done it in any other RStudio's projects before, please sign the individual or corporate contributor agreement for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). You can send the signed copy to jj@rstudio.com.

  • Add the journalname_article() function to R/article.R if the output format is simple enough, otherwise create a separate R/journalname_article.R.

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

@stefanocoretta stefanocoretta marked this pull request as draft January 2, 2021 11:53
@cderv
Copy link
Collaborator

cderv commented Jan 2, 2021

Hi @stefanocoretta,

I planned to review on Monday. Is it closed on purpose ? Do you still suggest we add this format into the package?

@cderv cderv self-requested a review January 2, 2021 14:08
@stefanocoretta
Copy link
Contributor Author

Hi!

Same as with jasa_article(). :)

@stefanocoretta stefanocoretta reopened this Jan 2, 2021
@stefanocoretta stefanocoretta marked this pull request as ready for review January 2, 2021 16:08
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 for the contribution !

I made a few comments to improve and one thing you must fix : currently adding a bibliography file will fail the rendering. This is because some Pandoc stuff are missing that you need when Pandoc citeproc is used. Your default does not use bibtex or natbib here but Pandoc citeproc.

Thanks!

R/article.R Outdated Show resolved Hide resolved
inst/rmarkdown/templates/pihph/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/pihph/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/pihph/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/pihph/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
inst/rmarkdown/templates/pihph/template.yaml Outdated Show resolved Hide resolved
Stefano Coretta and others added 4 commits January 6, 2021 14:25
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
In case user removes `gloss` in the yaml preamble.

Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
@stefanocoretta
Copy link
Contributor Author

Thanks for checking on this! I will work on the other changes in the next days.

@stefanocoretta stefanocoretta marked this pull request as draft January 8, 2021 11:33
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.

From the CI error it seems there is a $end$ or other missing in the template 🤔

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.

I commented on the part that make the CI error

inst/rmarkdown/templates/pihph/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
@stefanocoretta stefanocoretta marked this pull request as ready for review January 21, 2021 16:53
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 @stefanocoretta !

@cderv cderv merged commit 8d68165 into rstudio:master Feb 9, 2021
@stefanocoretta stefanocoretta deleted the pihph-article branch February 9, 2021 14:13
stefanocoretta pushed a commit to stefanocoretta/rticles that referenced this pull request Apr 3, 2021
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2021
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.

None yet

2 participants