{"id":51550295,"url":"https://github.com/gesiscss/kodaqs-toolbox.gesis.org","last_synced_at":"2026-07-09T23:01:48.909Z","repository":{"id":311913149,"uuid":"1045537810","full_name":"gesiscss/kodaqs-toolbox.gesis.org","owner":"gesiscss","description":"Code to build the KODAQS Data Quality Toolbox. This repository is a mirror.","archived":false,"fork":false,"pushed_at":"2026-04-01T07:02:18.000Z","size":112252,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-01T09:37:18.600Z","etag":null,"topics":["gesis"],"latest_commit_sha":null,"homepage":"https://kodaqs-toolbox.gesis.org","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gesiscss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-27T10:32:33.000Z","updated_at":"2026-04-01T07:02:21.000Z","dependencies_parsed_at":"2025-09-23T17:14:19.245Z","dependency_job_id":"eb74cd03-0165-41a5-8afa-8e3be44ab3d4","html_url":"https://github.com/gesiscss/kodaqs-toolbox.gesis.org","commit_stats":null,"previous_names":["gesiscss/kodaqs-toolbox.gesis.org"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gesiscss/kodaqs-toolbox.gesis.org","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesiscss%2Fkodaqs-toolbox.gesis.org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesiscss%2Fkodaqs-toolbox.gesis.org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesiscss%2Fkodaqs-toolbox.gesis.org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesiscss%2Fkodaqs-toolbox.gesis.org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gesiscss","download_url":"https://codeload.github.com/gesiscss/kodaqs-toolbox.gesis.org/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesiscss%2Fkodaqs-toolbox.gesis.org/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35314872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-09T02:00:07.329Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gesis"],"created_at":"2026-07-09T23:01:45.559Z","updated_at":"2026-07-09T23:01:48.902Z","avatar_url":"https://github.com/gesiscss.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kodaqs-toolbox.gesis.org \u003cimg src=\"img/logo.jpg\" align=\"right\" /\u003e\n\nThis repository contains the code for building the KODAQS Data Quality Toolbox website [kodaqs-toolbox.gesis.org](https://kodaqs-toolbox.gesis.org).\n\nBased on the R package [`andrew`](https://github.com/GESIS-Methods-Hub/andrew) (Aggregator for Navigatable Discoverable Reproducible and Educational work), reusable tools in the form of literate programming documents such as [R Markdown](https://rmarkdown.rstudio.com/), [Quarto Documents](https://quarto.org/docs/get-started/hello/rstudio.html), and [Jupyter Notebooks](https://nbformat.readthedocs.io/) are collected from different repositories, reproduced in [containers](https://en.wikipedia.org/wiki/OS-level_virtualization), and compiled into a single static website.\nIn our KODAQS Toolbox, we focus on tools and resources related to data quality. However, the approach is generic and can be applied to other domains as well.\n\nBelow is the workflow of the building process.\n\n![Workflow](img/workflow.png)\n\n\n## Dependencies\n\n- [Docker](https://www.docker.com/)\n- Quarto \u003e= 1.3\n- Dependencies specified in [`env.yaml`](./env.yaml)\n\n### Dependencies installation\n\nFor Docker, follow the steps in [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/).\nNote that Docker must be configured to be able to run without superuser privileges.\nYou can achieve this by either:\n\n- rootless Docker installation (https://docs.docker.com/engine/security/rootless/)\n- or: add your user to the `docker` group (https://docs.docker.com/engine/install/linux-postinstall/)\n\nFor Quarto, download the latest release from https://github.com/quarto-dev/quarto-cli/releases.\n\nExcept for Docker and Quarto, all the dependencies can be installed with `mamba` or `conda`.\nInstall `micromamba` following the [Mamba Documentation](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html) and create the environment specified in `env.yaml`:\n\n```bash\nmicromamba create -y -n andrew -f env.yaml\n```\n\n\n## How to build the website\n\nMake sure the environment `andrew` is activated, for example:\n\n```bash\nmicromamba activate andrew\n```\n\nTo build the KODAQS Toolbox website as a demo, run the following command in the root directory of the repository:\n\n```bash\nRscript start.R\n```\n\nThen, render the website with Quarto:\n\n```bash\n./render.sh\n```\n\nThe static website will be generated in the `demo/_site/` folder.\n\n## Developer notes\n\nThe file `main.R` is the entrypoint for the pipeline. It consists of the following steps:\n\n- downloading (cloning the repositories) in `download_contributions.R`. They will be stored in the repository names without underscore.\n- compiling the contributions to markdown and removing all dynamic elements (should be static md afterwards). This is done in `render_contributions.R`.\n  1. create a docker container depending on the needs (python, R, etc.)\n  2. run compilation scripts in the container (`inst/docker-scripts`) to map the different repository types and entry points\n  3. copy/using valumes to move the resulting static markdown to the repositories with underscore.\n- automatically create a quarto structure for composing the different repositories into one website\n\n### Using a minimal example for debugging\n\nIn the directory `minimal_example/` there is a pipeline to build only one tool to test the process. It does not fulfill all the requirements of the main pipeline but it is a faster way of testing new tool integration.\nThe corresponding scripts are `start_minimal.R` and `render_minimal.sh`.\n\n## Deployment\n\n- `deploy.sh` deploys the rendered website to `/var/www/html/`. (NOTE: all content in `/var/www/html/` will be deleted before deployment!)\n\n## Customization\n\nEdit the entries in the following files for customized tools:\n\n  - `content-contributions.json` (with the git tag for fixed version)\n  - `tags.json` (to generated link page)\n  - `zettelkasten.json` (for the hierarchy generation)\n\n## Similar projects\n\n- [R Universe](https://r-universe.dev)\n- [Gallery of Jupyter Books](https://executablebooks.org/en/latest/gallery/)\n- [`matplotlib` Examples](https://matplotlib.org/stable/gallery/index.html)\n\n## Contributing\n\nTo contribute to this repository, please fork the repository and create a pull request with your changes. We welcome contributions that improve the code, documentation, or add new features.\n\n## About KODAQS\n\nThe **Competence Center Data Quality in the Social Sciences (KODAQS)**, a partnership between **GESIS**, the **University of Mannheim**, and **LMU Munich**, offers demand-oriented support for the evaluation and analysis of the quality of social science data. Learn more about the KODAQS project [here](https://www.gesis.org/en/research/external-funding-projects/kodaqs-project-page).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesiscss%2Fkodaqs-toolbox.gesis.org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgesiscss%2Fkodaqs-toolbox.gesis.org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesiscss%2Fkodaqs-toolbox.gesis.org/lists"}