Modelling Marti
An Analysis of Planning Journalism
This repository contains quantitative text Analyses of publications by Hans Marti. The data in this repository is openly available to everyone and is intended to support reproducible research.
Repository Structure
The structure of this repository follows the Advanced Structure for Data Analysis of The Turing Way and is organized as follows:
analysis/
: scripts and notebooks used to analyze the dataassets/
: images, logos, etc. used in the README and other documentationbuild/
: scripts and notebooks used to build the datadata/
: data filesdocs/
: documentation for the data and the repositoryreport/
: report on the data set and analysissrc/
: source code for the data (e.g., scripts used to collect or process the data)
Data Description
- TODO Describe the data in this repository, including what it represents, how it was collected or obtained, any preprocessing or cleaning that was done, and any limitations or potential biases.
- TODO Data models, including field names, descriptions, and controlled values, should be clearly documented in a static document that is maintained with the data and is part of the products.
- TODO All rights and intellectual property issues should be clearly documented. Where possible, data and products should be released under open licenses (Creative Commons, GNU, BSD, MPL). – TODO Set up Zenodo integration
Installation
Install Node.js, Quarto and R. Run the following commands in the root directory of the repository:
npm install
Set up the R environment using renv:
npm run setup
Use
Check that all files are properly formatted.
npm run check
Format all files.
npm run format
Run the wizard to write meaningful commit messages.
npm run commit
Run the wizard to create a CHANGELOG.md.
npm run changelog
Preview the documentation.
quarto preview
Support
This project is maintained by @mtwente. Please understand that we can’t provide individual support via email. We also believe that help is much more valuable when it’s shared publicly, so more people can benefit from it.
Type | Platforms |
---|---|
🚨 Bug Reports | GitHub Issue Tracker |
📊 Report bad data | GitHub Issue Tracker |
📚 Docs Issue | GitHub Issue Tracker |
🎁 Feature Requests | GitHub Issue Tracker |
🛡 Report a security vulnerability | See SECURITY.md |
💬 General Questions | GitHub Discussions |
Roadmap
No changes are currently planned.
Contributing
All contributions to this repository are welcome! If you find errors or problems with the data, or if you want to add new data or features, please open an issue or pull request. Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
Versioning
We use SemVer for versioning. The available versions are listed in the tags on this repository.
License
The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the LICENSE-CCBY file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.
The code in this repository is released under the GNU Affero General Public License v3.0 - see the LICENSE-AGPL file for details. By using this code, you agree to make any modifications available under the same license.