Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/centrefordigitalhumanities/coloringbook-utils
https://github.com/centrefordigitalhumanities/coloringbook-utils
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/centrefordigitalhumanities/coloringbook-utils
- Owner: CentreForDigitalHumanities
- License: gpl-3.0
- Created: 2023-10-26T06:41:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-26T11:43:47.000Z (7 months ago)
- Last Synced: 2024-04-26T12:43:39.936Z (7 months ago)
- Language: Python
- Size: 5.46 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Coloring Book Utils
[![DOI](https://zenodo.org/badge/710165879.svg)](https://zenodo.org/doi/10.5281/zenodo.10997471)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)This is a command-line interface to use for analyzing [Coloring Book](https://github.com/UUDigitalHumanitieslab/coloringbook) data.
## Installation
To install, use [pipx](https://pypa.github.io/pipx/installation/)
`pipx install git+https://github.com/CentreForDigitalHumanities/coloringbook-utils`
To validate that your installation worked, run `cb-utils --help`
If this executes correctly, then installation was successful.
## Usage
This tool offers 2 commands:
- `cb-utils summarize`
- `cb-utils build`Below are explanations of each.
Every command must be prefixed with a reference to a configuration file.
The configuration file is written in `toml` and looks like so:```toml
expectations = "data/expectations.csv"
matching = "data/matching.csv"
participants = "data/participants.csv"
responses = "data/responses.csv"
any_color = false
output_file_prefix = ".data/output"
```### Summarize
You can use summary as a sanity check to get some quick stats about the data.
The command will show you three tables: survey summary, page summary, and page guess summary.An example of the usage is:
```bash
cb-utils --config config.toml summarize -t results
```or
```bash
cb-utils --config config.toml summarize -t survey
```This will output data about guesses and the survey respectively.
You can append a `--write` flag to store this data in a file:```bash
cb-utils --config config.toml summarize -t results --write
```### Build
With build you can synthesize the data into a single csv.
You can invoke the command as so:
```bash
cb-utils --config config.toml build
```## Troubleshooting
- If you get the following error: `polars.exceptions.SchemaFieldNotFoundError:`, please ensure that there are no spaces in the headers of any files
- The participants file must be a csv (separated by commas). You can export it to this format through excel (or any other spreadsheet software)
- If something does not work as expected or an output is incorrect, please make a github issue and if possible provide:
- An example input
- The expected output
- The actual output## Licence
This work is shared under a GPL-3.0 licence. See [LICENSE](./LICENSE) for more information.
## Citation
To cite this repository, please use the metadata provided in [CITATION.cff](./CITATION.cff).
## Contact
Coloring Book Utils is developed by Donatas Rasiukevičius, with contributions by Xander Vertegaal, at the Centre for Digital Humanities, Utrecht University.
For questions or suggestions, [contact the Centre for Digital Humanities](https://cdh.uu.nl/contact/) or open an issue in this respository.