Package: sandpaper 0.16.11

Robert Davey

sandpaper: Create and Curate Carpentries Lessons

We provide tools to build a Carpentries-themed lesson repository into an accessible standalone static website. These include local tools and those designed to be used in a continuous integration context so that all the lesson author needs to focus on is writing the content of the actual lesson.

Authors:Robert Davey [aut, cre], Erin Becker [aut], Zhian N. Kamvar [aut], Julien Colomb [ctb], Ben Companjen [ctb], Toby Hodges [ctb], François Michonneau [ctb], Kelly Barnes [ctb], Hugo Gruson [ctb], Milan Malfait [ctb], Joel H. Nitta [aut, trl], Yanina Bellini Saibene [ctb, trl], Martin Raden [ctb, trl], Matthew Armstrong [ctb]

sandpaper_0.16.11.tar.gz
sandpaper_0.16.11.zip(r-4.5)sandpaper_0.16.11.zip(r-4.4)sandpaper_0.16.11.zip(r-4.3)
sandpaper_0.16.11.tgz(r-4.5-any)sandpaper_0.16.11.tgz(r-4.4-any)sandpaper_0.16.11.tgz(r-4.3-any)
sandpaper_0.16.11.tar.gz(r-4.5-noble)sandpaper_0.16.11.tar.gz(r-4.4-noble)
sandpaper_0.16.11.tgz(r-4.4-emscripten)sandpaper_0.16.11.tgz(r-4.3-emscripten)
sandpaper.pdf |sandpaper.html✨
sandpaper/json (API)
NEWS

# Install 'sandpaper' in R:

install.packages('sandpaper', repos = c('https://carpentries.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/carpentries/sandpaper/issues

Pkgdown site:https://carpentries.github.io

On CRAN:

carpentries carpentries-infrastructure carpentries-workbench lesson-template lessons markdown static-site-generator

7.72 score 44 stars 8 scripts 58 exports 76 dependencies

Last updated 1 months agofrom:2114ec60ed (on 0.16.11). Checks:8 OK. Indexed: yes.

Target	Result	Latest binary
Doc / Vignettes	OK	Feb 16 2025
R-4.5-win	OK	Feb 16 2025
R-4.5-mac	OK	Feb 16 2025
R-4.5-linux	OK	Feb 16 2025
R-4.4-win	OK	Feb 16 2025
R-4.4-mac	OK	Feb 16 2025
R-4.3-win	OK	Feb 16 2025
R-4.3-mac	OK	Feb 16 2025

Exports:build_episode_html build_episode_md build_handout build_lesson check_lesson create_episode create_episode_md create_episode_rmd create_lesson draft_episode_md draft_episode_rmd get_config get_drafts get_dropdown get_episodes get_instructors get_learners get_profiles get_syllabus known_languages manage_deps move_episode no_package_cache package_cache_trigger pin_version renv_diagnostics reset_episodes reset_site sandpaper_site serve set_config set_dropdown set_episodes set_instructors set_learners set_profiles strip_prefix template_citation template_conduct template_config template_contributing template_episode template_gitignore template_index template_license template_links template_metadata template_pkgdown template_placeholder template_pr_diff template_setup template_sidebar_item update_cache update_github_workflows update_varnish use_package_cache validate_lesson work_with_cache

Dependencies:askpass assertthat base64enc brio bslib cachem callr cli clipr commonmark cpp11 crayon credentials curl desc digest downlit evaluate fansi fastmap fontawesome fs gert gh gitcreds glue highr htmltools httpuv httr2 ini jquerylib jsonlite knitr later lifecycle magrittr memoise mime openssl pegboard pillar pkgconfig pkgdown processx promises ps purrr R6 ragg rappdirs Rcpp renv rlang rmarkdown rprojroot rstudioapi sass servr stringi sys systemfonts textshaping tibble tinkr tinytex usethis utf8 vctrs whisker withr xfun xml2 xslt yaml zip

Building Lessons With A Package Cache

Rendered frombuilding-with-renv.Rmdusingknitr::rmarkdownon Feb 16 2025.

Last update: 2023-07-07
Started: 2021-09-16

Data and Flow from Source to Website

Zhian N. Kamvar

Rendered fromdata-flow.Rmdusingknitr::rmarkdownon Feb 16 2025.

Last update: 2024-03-05
Started: 2023-12-07

Including Child Documents

Rendered frominclude-child-documents.Rmdusingknitr::rmarkdownon Feb 16 2025.

Last update: 2024-03-05
Started: 2023-09-26

Translating The Workbench

Rendered fromtranslations.Rmdusingknitr::rmarkdownon Feb 16 2025.

Last update: 2023-12-19
Started: 2023-12-07

Working with Automated Pull Requests

Rendered fromautomated-pull-requests.Rmdusingknitr::rmarkdownon Feb 16 2025.

Last update: 2022-11-08
Started: 2021-09-16

Help page	Topics
Create a code handout of challenges without solutions	build_handout
Build your lesson site	build_lesson
Create an Episode from a template	create_episode create_episode_md create_episode_rmd draft_episode_md draft_episode_rmd
Create a carpentries lesson	create_lesson
Get the configuration parameters for the lesson	get_config
Show files in draft form	get_drafts
Helpers to extract contents of dropdown menus on the site	get_dropdown get_episodes get_instructors get_learners get_profiles
Show a list of languages known by '{sandpaper}'	known_languages
Lesson Runtime Dependency Management	manage_deps pin_version update_cache
Move an episode in the schedule	move_episode
Clear the schedule in the lesson	reset_episodes
Remove all files associated with the site	reset_site
Global Options	sandpaper.options
Build your lesson and work on it at the same time	serve
Set individual keys in a configuration file	set_config
Set the order of items in a dropdown menu	set_dropdown set_episodes set_instructors set_learners set_profiles
This will strip existing episode prefixes and set the schedule	strip_prefix
Update github workflows	update_github_workflows
Update the local version of the carpentries style	update_varnish
Give Consent to Use Package Cache	no_package_cache package_cache_trigger use_package_cache

Package: sandpaper 0.16.11

sandpaper: Create and Curate Carpentries Lessons

Building Lessons With A Package Cache

Data and Flow from Source to Website

Including Child Documents

Translating The Workbench

Working with Automated Pull Requests

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)