sal_get_metadata: Get a dataset's 'metadata'.

In knapply/salinasr: An R package for programmatic access to the Salinas Open Data Portal API.

Description

The metadata class is a thin wrapper around a nested list object. It provides a consistent start point to explore information about datasets and safely import them into R.

Usage

sal_get_metadata(x, prioritize_cache = TRUE,
  cache_dir = "~/salinasr-cache")

## S3 method for class 'tbl_df'
sal_get_metadata(x, prioritize_cache = TRUE,
  cache_dir = "~/salinasr-cache")

## S3 method for class 'character'
sal_get_metadata(dataset_id, prioritize_cache = TRUE,
  cache_dir = "~/salinasr-cache")

## S3 method for class 'metadata'
print(x, cache_dir = "~/salinasr-cache")

Arguments

x	character representing a dataset_id or tibble obtained via sal_get_dataset().
prioritize_cache	logical, whether to cache data locally to prevent redundant API calls.
cache_dir	character, path to read/write data.
dataset_id	character, ID used to identify dataset.

Value

metadata object

Methods (by class)

• tbl_df: Method to obtain a metadata object from a tbl_df obtained from a metadata object in the event something occurred to the original metadata object.

• character: Method to obtain a metadata object from a dataset_id.

• metadata: Method to print metadata object. Empty metadata attributes are colored in red.

Author(s)

Brendan Knapp [e-mail]

References

https://cityofsalinas.opendatasoft.com/explore/

Examples

library(salinasr)

meta <- sal_get_metadata("bikeways")

meta

meta$description

knapply/salinasr documentation built on May 27, 2019, 2:09 p.m.