Package index • cvmdata

Fetchers

Five functions to retrieve any CVM open-data table covered by the package. v0.1.0.9000 ships only issuer_fetch() as functional; fund_fetch(), agent_fetch(), offering_fetch() and event_fetch() are exported as skeletons documenting the planned v0.4-v0.8 contracts (calling them aborts with cvmdata_error_input_group).

issuer_fetch(): Fetch a CVM open-data table for an issuer dataset
fund_fetch(): Fetch a CVM open-data table for a fund dataset
agent_fetch(): Fetch a CVM open-data table for a registered-agent dataset
offering_fetch(): Fetch a CVM open-data table for a public-offering dataset
event_fetch(): Fetch a CVM open-data table for a regulatory-event dataset

Cache

Inspect and manage the on-disk cache of downloaded artifacts. The TTL window for HTTP revalidation is configurable via the cvmdata.cache_ttl_seconds option (default 30 days).

cvm_cache_path(): Path to the cvmdata cache directory
cvm_cache_set_path(): Set the cvmdata cache directory
cvm_cache_info(): Inventory of files in the cvmdata cache
cvm_cache_clear(): Clear cached files

Source backend

Configure which backend issuer_fetch() queries (direct CVM portal or the parquet mirror published in GitHub Releases).

cvm_source_get(): Get the active cvmdata source backend
cvm_source_set(): Set the active cvmdata source backend

Discovery

Browse the CKAN groups, datasets, tables, dictionaries and code lists carried by the package. cvm_groups() is the entry point that lists every group covered by the project roadmap (only companhias is functionally implemented in v0.1.0.9000); the remaining functions accept an optional group argument that disambiguates when a dataset slug occurs in more than one group.

cvm_groups(): List the CVM CKAN groups
cvm_datasets(): List datasets covered by the package
cvm_tables(): List the tables published in a dataset
cvm_dictionary(): Look up the CVM-published dictionary for a table
cvm_codelist(): Look up the codelist for a categorical column
cvm_dataset_years(): Range of years available for a yearly-partitioned dataset

Utilities

CNPJ formatting helpers.

cnpj_clean(): Strip punctuation from a CNPJ vector
cnpj_format(): Format a CNPJ vector with the canonical punctuation