Skip to contents

Populate the local baseline-schema cache from a snapshot metadata directory

Source: R/oa_schema.R
oa_cache_schema.Rd

Copies unified_schema.csv files from an OpenAlex snapshot metadata directory (e.g. /Volumes/openalex/openalex-snapshot_metadata) into the user-level cache used by pro_request_parquet(schema = "auto").

Usage

oa_cache_schema(source, entities = "all", overwrite = FALSE, verbose = TRUE)

Arguments

source

Path to the snapshot metadata directory, e.g. "/Volumes/openalex/openalex-snapshot_metadata".

entities

Character vector of entity names to cache, or "all" (default) to cache every entity directory found under source.

overwrite

Logical. Overwrite an existing cached file? Default FALSE.

verbose

Logical. Print progress messages? Default TRUE.

Value

The path to the schemata cache directory (invisibly).

Details

Once cached, the schemas are used even when the source volume is not mounted. Update the cache periodically to pick up new fields added by OpenAlex (run with overwrite = TRUE).

See also

pro_request_parquet for the schema parameter.