Package index • webrarian

Collection Management

Start, find and copy collections

catalog(): Catalog a new webrarian project
is_collection(): Check if directory is a webrarian collection
collection_root(): Find collection root
collection_example(): Copy an example collection

Build & Preview

Build the site and preview it locally

bind(): Bind the collection into a site
reading_room(): Open the reading room (preview server)
reading_room_close(): Close the reading room (stop preview server)
clean_shelves(): Clean the shelves

Packages

Add, remove, list and check R packages

acquire_package(): Acquire R packages for the collection
withdraw_package(): Withdraw packages from the collection
collection_packages(): List the packages a collection uses
check_inventory(): Check inventory (package availability in webR repositories)

Files

Add, remove and list files

acquire_file(): Acquire files for the collection
withdraw_file(): Withdraw files from the collection
collection_files(): List the files a collection bundles

Settings

Read and change collection settings

collection_settings(): Read collection settings
settings_get(): Get a settings value
settings_set(): Set configuration values

Deployment

Deploy to GitHub Pages, Netlify and other static hosts

circulate_via_github(): Circulate via GitHub Actions
circulate_via_netlify(): Circulate via Netlify

Mirrors

Self-contained webR sites for air-gapped networks

collection_mirror(): Create a webR mirror for self-hosted or air-gapped deployment

Diagnostics and cache

Check a collection and manage webrarian’s download cache

diagnose_collection(): Diagnose collection
webr_cache_info(): Show cache information
webr_cache_clear(): Clear the webrarian cache