Read collection settings

Reads and returns the project configuration from _webrarian.yml.

Usage

collection_settings(path = ".")

Arguments

path

Path to project directory (the current directory by default)

Value

A list with class webrarian_config containing the configuration

Examples

# Read the settings of one of the bundled example collections
config <- collection_settings(collection_example("data-analysis"))
#> ✔ Copied the "data-analysis" example to /tmp/RtmpQU25pJ/webrarian-data-analysis-206b9ffddd9
config$project$name
#> [1] "Package Demo"
config$webr$version
#> [1] "0.6.0"

# The print method summarizes the whole configuration
config
#> 
#> ── Webrarian Configuration ─────────────────────────────────────────────────────
#> Project: "Package Demo"
#> Path: /tmp/RtmpQU25pJ/webrarian-data-analysis-206b9ffddd9
#> 
#> ── webR ──
#> 
#> Version: "0.6.0"
#> 
#> ── Packages ──
#> 
#> Prebuilt: 3, GitHub: 0, Local: 0
#> 
#> ── Files ──
#> 
#> Include patterns: 2
#> Mount point: /home/web_user
#> 
#> ── REPL ──
#> 
#> Panels: "editor", "terminal", "files", "plot", and "environment"
#> Share links: "open"
#> 
#> ── UI ──
#> 
#> Loading: "Loading..."
#> 
#> ── Build ──
#> 
#> Output: _site
#> Offline: FALSE
#> Bundle engine: TRUE
#> Service worker: FALSE