Acquire files for the collection — acquire

Adds files, directories or glob patterns to files.include in _webrarian.yml. bind() copies what they match into the site, under the collection-wide files.mount-point (see settings_set()), which this function never changes. A path or pattern that matches nothing, or a path outside the collection, is an error.

Usage

acquire_file(paths, path = ".")

Arguments

paths: Character vector of file or directory paths (data/) or glob patterns (scripts/*.R), relative to the collection.
path: The collection, or any directory inside it.

Value

Invisibly returns the updated configuration.

Examples

collection <- file.path(tempdir(), "webrarian-acquire-files")
catalog(collection)
#> ✔ Created directory /tmp/RtmpQU25pJ/webrarian-acquire-files
#> ✔ Created _webrarian.yml
#> ✔ Added "_site/" and ".webrarian/" to .gitignore
#> ✔ Cataloged webrarian collection: "webrarian-acquire-files"
#> 
#> Next steps:
#>   Move into the collection: `setwd("/tmp/RtmpQU25pJ/webrarian-acquire-files")`
#>   Acquire packages: `webrarian::acquire_package("dplyr")`
#>   Acquire files: `webrarian::acquire_file("data/")`
#>   Bind: `webrarian::bind()`
#>   Reading room: `webrarian::reading_room()`
#> ℹ Or pass `path` to each call, e.g. `webrarian::bind(path =
#>   "/tmp/RtmpQU25pJ/webrarian-acquire-files")`
dir.create(file.path(collection, "data"))
dir.create(file.path(collection, "scripts"))
writeLines("x,y\n1,2", file.path(collection, "data", "dataset.csv"))
writeLines("summary(1:10)", file.path(collection, "scripts", "analysis.R"))

# Add a directory
acquire_file("data/", path = collection)
#> ✔ Added 1 path: data/

# Add a specific file
acquire_file("scripts/analysis.R", path = collection)
#> ✔ Added 1 path: scripts/analysis.R

# Add with a glob pattern
acquire_file("scripts/*.R", path = collection)
#> ✔ Added 1 path: scripts/*.R

collection_files(collection)
#> 
#> ── Collection files ────────────────────────────────────────────────────────────
#> Include: "data/", "scripts/analysis.R", and "scripts/*.R"
#> Exclude: "**/*.Rhistory" and "**/.DS_Store"
#> Mount point: /home/web_user
#> 
#> ── 2 files bundled ──
#> 
#> • data/dataset.csv
#> • scripts/analysis.R

unlink(collection, recursive = TRUE)