Skip to contents

[Superseded]

Use pb$readmes() on a peekbank() client.

Downloads README files for Peekbank datasets from Redivis.

Usage

get_readmes(
  datasets = c(),
  local_base_dir = "dataset_readmes",
  connection = NULL
)

Arguments

datasets

Character vector of dataset names. If empty (default), downloads READMEs for all datasets.

local_base_dir

Directory to save README files to (default: "dataset_readmes")

connection

A connection to the peekbank database

Value

No return value, called for side effects. README files are saved to the specified directory and the path is printed via message.

Examples

if (FALSE) { # \dontrun{
con <- connect_to_peekbank("2025.1")
get_readmes(connection = con)
get_readmes(datasets = c("pomper_saffran_2016"), connection = con)
} # }