coloringbook-utils
https://github.com/centrefordigitalhumanities/coloringbook-utils
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: CentreForDigitalHumanities
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Size: 5.46 MB
Statistics
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
- Releases: 1
Metadata Files
readme.md
Coloring Book Utils
This is a command-line interface to use for analyzing Coloring Book data.
Installation
To install, use pipx
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 summarizecb-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 for more information.
Citation
To cite this repository, please use the metadata provided in 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 or open an issue in this respository.
Owner
- Name: Centre for Digital Humanities
- Login: CentreForDigitalHumanities
- Kind: organization
- Email: cdh@uu.nl
- Location: Netherlands
- Website: https://cdh.uu.nl/
- Repositories: 39
- Profile: https://github.com/CentreForDigitalHumanities
Interdisciplinary centre for research and education in computational and data-driven methods in the humanities.
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: coloringbook-utils
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Donatas
family-names: Rasiukevicius
email: d.rasiukevicius@uu.nl
affiliation: Utrecht University
orcid: 'https://orcid.org/0009-0006-3103-0108'
- given-names: Alexander
family-names: Vertegaal
email: a.j.j.vertegaal@uu.nl
affiliation: Utrecht University
orcid: 'https://orcid.org/0000-0002-5182-6801'
identifiers:
- type: doi
value: 10.5281/zenodo.10997472
repository-code: >-
https://github.com/CentreForDigitalHumanities/coloringbook-utils
abstract: Preparing Coloring Book data for analysis
license: GPL-3.0
commit: 728fea383abc9247a85661cf0826055f4b8f4596
version: 1.0.0
date-released: '2024-04-19'
GitHub Events
Total
- Member event: 1
Last Year
- Member event: 1
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Donatas Rasiukevičius | d****s@u****l | 10 |
| Xander Vertegaal | a****l@u****l | 3 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 6
- Total pull requests: 4
- Average time to close issues: about 5 hours
- Average time to close pull requests: 9 days
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- fliepeltje (5)
Pull Request Authors
- XanderVertegaal (5)