https://github.com/scienceverse/metacheck_book
The metacheck Book — a Quarto book documenting the metacheck R package
https://github.com/scienceverse/metacheck_book
Last synced: 11 days ago
JSON representation
The metacheck Book — a Quarto book documenting the metacheck R package
- Host: GitHub
- URL: https://github.com/scienceverse/metacheck_book
- Owner: scienceverse
- Created: 2026-06-24T06:21:35.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-07-03T18:47:34.000Z (22 days ago)
- Last Synced: 2026-07-03T20:26:22.521Z (22 days ago)
- Language: JavaScript
- Homepage: https://www.scienceverse.org/metacheck_book/
- Size: 21.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The metacheck Book
Source for the online book documenting the [metacheck](https://github.com/scienceverse/metacheck) R package, built with [Quarto](https://quarto.org).
The book collects the package's vignettes and documentation into a single
structured, browsable resource.
## Building locally
You need [Quarto](https://quarto.org/docs/get-started/) and an R installation
with the `metacheck` package available:
``` r
pak::pkg_install("scienceverse/metacheck")
```
Then render the book:
``` bash
quarto render
```
The rendered site is written to `docs/` (configured in `_quarto.yml`), which can
be served by GitHub Pages.
### Code execution
Chapters are configured with `execute: freeze: true`. Quarto will only re-run a
chapter's R code when that chapter's source changes, using the cached output in
`_freeze/` otherwise. This keeps routine rebuilds fast and avoids re-running
network- or LLM-dependent code on every render.
To force a full re-execution, delete the `_freeze/` directory before rendering.
## Structure
- `index.qmd` — landing page.
- `chapters/` — the polished chapters (sourced from the package vignettes).
- `drafts/` — work-in-progress and reference material from the package
`_stuff/` folder; not guaranteed to render cleanly.
- `images/` — figures used by chapters.
- `include/book.bib` — merged bibliography for the whole book.
- `include/apa.csl` — APA 7th edition citation style.
- `theme.scss` — metacheck-branded styling.
## License
Content follows the licensing of the metacheck package and its vignettes.