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 Copernicus Publications template #172

Merged
merged 6 commits into from
Sep 20, 2018
Merged

Conversation

nuest
Copy link
Contributor

@nuest nuest commented May 28, 2018

This PR add the template by Copernicus Publications, a small open access publisher in the geosciences, based on https://publications.copernicus.org/for_authors/manuscript_preparation.html

Copy link
Member

@yihui yihui left a comment

Choose a reason for hiding this comment

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

Could you rebase against the current master branch and resolve the conflicts? You will need force push.

Could you also remove the standard LaTeX packages in this PR? Users should install these packages by themselves. If you use TinyTeX, missing LaTeX packages can be automatically installed: https://yihui.name/tinytex/.

"-autolink_bare_uris", # disables automatic links, needed for plain email in \correspondence
"-auto_identifiers" # disables \hypertarget commands
)) {
if (inherits(base_format, "character")) {
Copy link
Member

Choose a reason for hiding this comment

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

How about is.character()?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just copied this from peerj_article, but happy to change to is.character().

#' names(copernicus_journal_abbreviations())
#' copernicus_journal_abbreviations(name = "Science Data")
#'
#' @export
Copy link
Member

Choose a reason for hiding this comment

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

I'd merge the doc of this function with copernicus_article, i.e.

#' @rdname copernicus_article

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@yihui yihui force-pushed the master branch 3 times, most recently from 8023cbf to 928d6cd Compare July 3, 2018 16:11
(squashed changes)

- update to template package version 5.0
- appendix may not be loaded via external file, use yaml property instead
- add hints for additional metadata
- add default language for babel
- add default language for babel
- fix tightlist in pandoc
- no HTML comments with LaTeX in it
- update docs
- clarify usage of quations, closes #1
- clarify docs for algorithm packages
- add examples for usage of \unit{}
@nuest
Copy link
Contributor Author

nuest commented Jul 30, 2018

@yihui Thanks for taking a look, and my sincere apologies for the delay. I tried to incorporate your requirements. Could you please clarify what you mean by "Could you also remove the standard LaTeX packages in this PR?"

@nuest
Copy link
Contributor Author

nuest commented Jul 30, 2018

Contributor agreement is on the way, too.

@yihui
Copy link
Member

yihui commented Jul 30, 2018

I meant standard packages like natbib.sty. These could be easily installed from CTAN, so we should not ship copies of them in this R package.

To check if a package is on CTAN, you may use, e.g.,

> tinytex:::parse_packages(files = 'natbib.sty')
tlmgr search --file --global '/natbib.sty'
[1] "natbib"

@nuest
Copy link
Contributor Author

nuest commented Jul 30, 2018

I understand. Removed natbib.sty and pdfscreen.sty from inst/../copernicus_article/skeleton but left pdfsceencop.sty in there.

> tinytex:::parse_packages(files = 'pdfscreencop.sty')
tlmgr search --file --global '/pdfscreencop.sty'
character(0)
Warning message:
In tinytex:::parse_packages(files = "pdfscreencop.sty") :
  Failed to find a package that contains pdfscreencop.sty

Copy link
Member

@yihui yihui left a comment

Choose a reason for hiding this comment

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

Great! One last thing: could you also add an entry about this journal in README.md? Thanks!

@nuest
Copy link
Contributor Author

nuest commented Sep 10, 2018

The entry in the README.md was there already: https://github.com/rstudio/rticles/pull/172/files#diff-04c6e90faac2675aa89e2176d2eec7d8R55 Or would you like to have something different?

to not confuse Copernicus Publicatoins with "Copernicus Publishers"
 (https://flakyj.blogspot.com/2018/03/copernicus-publishers.html)
@yihui yihui added this to the v0.6 milestone Sep 20, 2018
Copy link
Member

@yihui yihui 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!

@yihui yihui merged commit b5da792 into rstudio:master Sep 20, 2018
@nuest
Copy link
Contributor Author

nuest commented Sep 26, 2018

Yay 🎆 🎉 !

@nuest
Copy link
Contributor Author

nuest commented Nov 6, 2018

I've written a blog article planned to be published in the EGU's GeoLog, the academic society behind Copernicus Publications, along with some social media activity. The draft is at

https://github.com/nuest/o2r-project.github.io/blob/egu-blog/_drafts/write-reproducible-manuscripts-for-copernicus-publishing-journals.md

Feedback of course welcome, but mostly just wanted to leave this here in case anyone stumbles across this PR.

@yihui
Copy link
Member

yihui commented Nov 6, 2018

Looks great! Thanks for sharing the post!

yihui added a commit that referenced this pull request Mar 14, 2019
@yihui
Copy link
Member

yihui commented Mar 14, 2019

Please note that I just removed the base_format argument you copied from peerj_article(), since I noticed that people started doing this in other output formats (#208), which is really not necessary. To make use of bookdown's features, now you need to use:

output:
  bookdown::pdf_book:
    base_format: rticles::copernicus_article

@nuest
Copy link
Contributor Author

nuest commented Jun 18, 2019

Copernicus now starts advertising the template in their manuscript preparation guidelines, see e.g. journal ACP at https://www.atmospheric-chemistry-and-physics.net/for_authors/manuscript_preparation.html

image

@yihui
Copy link
Member

yihui commented Jun 18, 2019

@nuest Awesome! Thanks for letting us know!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2020
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