Skip to content

Conversation

nicebread
Copy link
Member

No description provided.

@nicebread nicebread requested review from MalikaIhle and fkohrt July 16, 2025 14:33
@nicebread nicebread changed the title Shorten the data chapter Shorten the README chapter Jul 16, 2025
@fkohrt
Copy link
Member

fkohrt commented Sep 19, 2025

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**
Copy link
Member

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!*
Copy link
Member

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
Copy link
Member

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`.
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 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 💡"
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 favor no emojis

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

Successfully merging this pull request may close these issues.

2 participants