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

should we switch to .md from .Rmd for the ACC form #4

Open
paciorek opened this issue Jan 6, 2023 · 0 comments
Open

should we switch to .md from .Rmd for the ACC form #4

paciorek opened this issue Jan 6, 2023 · 0 comments

Comments

@paciorek
Copy link
Collaborator

paciorek commented Jan 6, 2023

For the Rmd version of the ACC form, we (briefly) discussed switching to .md during a recent AER monthly meeting, since there are no code chunks.

I like this idea in general, but when I looked into it more, I ran into the following.
RStudio won't recognize .md files when one tries to open script files. So an R-based user who tries to load the ACC form into RStudio will hit a roadblock. (That said, rmarkdown::render works fine on .md files.) Given many/most of our users are R-based, this seems suboptimal; we'd have to give more instructions on how to render the .md file. Rendering using pandoc and quarto are options, but many users may not have them installed on their system and/or know how to use them.

We could provide .md, .Rmd, and .qmd versions of the form. This has some appeal, but the content of the files would be almost identical except that the preface yaml for each needs to be a bit different (see below). Having duplicated content that we need to change in tandem when we update the form is not appealing.

Any thoughts welcome.

Side notes:

The preface for .qmd should be:

---
title: "Author Contributions Checklist Form"
date: "Revision: 2021-10-30"
format:
  pdf: default
---

The preface for .md should be:

---
title: "Author Contributions Checklist Form"
date: "Revision: 2021-10-30"
geometry: margin=1in
---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant