sal_describe_dataset: Describe a dataset's variables.

In brendan-g-knapp/salinasr: An R package for programmatic access to the Salinas Open Data Portal API.

Description

Describe a dataset's variables.

Usage

sal_describe_dataset(x)

## S3 method for class 'tbl_df'
sal_describe_dataset(x)

## S3 method for class 'character'
sal_describe_dataset(x)

## S3 method for class 'metadata'
sal_describe_dataset(x)

Arguments

x	A character describing a dataset_id, a tibble as obtained by sal_get_dataset() or a metadata object as obtained by sal_get_metadata().

Value

tibble::tibble with columns:

name	names of variables
label	(hopefully) helpful clarification of variables' names
type	original data type of variables

Methods (by class)

• tbl_df: Method to obtain description from a tibble::tibble

• character: Method to obtain description from a character.

• metadata: Method to obtain description from a metadata object obtained by sal_get_metadata().

Author(s)

Brendan Knapp [e-mail]

Examples

library(salinasr)

sal_get_metadata("bikeways") %>% 
  sal_get_dataset() %>% 
  sal_describe_dataset()

brendan-g-knapp/salinasr documentation built on May 22, 2019, 3:39 p.m.