-
Notifications
You must be signed in to change notification settings - Fork 0
Shorten the README chapter #2
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
base: main
Are you sure you want to change the base?
Conversation
I wonder why this pull request contains changes that were already committed earlier? I've made several comments on that commit that also apply to the changes (re)submitted here. |
structured by sections: | ||
|
||
### Involved Data | ||
**Name and Description** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this change decreases the accessibility of the page, because Name and Description is still meant to be a heading, but not syntactically described as such. If the font size of the heading is to large, we should use CSS.
We can see that the programs `make`, `pandoc`, | ||
and `git` were identified as system dependencies. | ||
Often, one can obtain their version by running them with the `--version` argument: | ||
If you do *not* use `renv`, the easiest solution to get a list of all needed packages is the `sessionInfo()` command. *Call it **after** you loaded all necessary packages!* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I'd agree. If we have to simplify it, I would recommend to add renv
in the end (rather than from the beginning) or just provide the output of renv::dependencies()
. sessionInfo()
only lists packages that were used since the last time one restarted R, which is generally not sufficient. (And for the cases where sessionInfo()
actually is useful, I'd still prefer sessioninfo::session_info()
.)
Finally, for steps that take more than a couple of seconds, | ||
indicate the approximate runtime. | ||
|
||
### List of Results |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Including a list of results is a recommendation by the AEA data editor Lars Vilhuber. I think it'd be nice if our tutorial were compatible with that, also to make it consistent with our other activities (e.g., the reproducibility check).
## License | ||
The manuscript files `Manuscript.qmd`, `Manuscript.tex`, and `Manuscript.pdf` by Josephine Zerna, Christoph Scheffel, and <YOUR NAME> are available under [CC\ BY-SA\ 4.0](https://creativecommons.org/licenses/by-sa/4.0/) or (at your option) under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) (or later). For further copyright information, see `LICENSE.txt`. | ||
The manuscript files `Manuscript.qmd`, `Manuscript.tex`, and `Manuscript.pdf` by Josephine Zerna, Christoph Scheffel, and <YOUR NAME> are available under [CC\ BY-SA\ 4.0](https://creativecommons.org/licenses/by-sa/4.0/). For further copyright information, see `LICENSE.txt`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say this is too much of a simplification, as it's not good to release code under CC BY-SA 4.0 only.
- make_readme.qmd | ||
- archive.qmd | ||
- section: "💡 In-depth material" | ||
- section: "Excursus: In-depth material 💡" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd favor no emojis
No description provided.