generate_parameter_index: Generate a table of parameter identifiers and their short...

Description Usage Arguments Value Examples

View source: R/database.R

Description

Generate a table of parameter identifiers and their short names

Usage

1
generate_parameter_index(cyan_connection, has_data = FALSE)

Arguments

cyan_connection

a CyAN database connection from connect_cyan()

has_data

a logical indicating whether to limit the parameter list to only those parameters that have data populated in the database

Value

a data frame of parameter identifiers and their associated short names

Examples

1
2
3
4
5
6
7
#Connect to the example database bundled with CyAN
path <- system.file("extdata", "example.db", package = "CyAN")
db_connection <- connect_cyan(path)
#Generate the parameter index
parameter_index <- generate_parameter_index(db_connection)
#Limit the index to the parameters that have data
parameter_index_hasdata <- generate_parameter_index(db_connection, has_data = TRUE)

PatrickEslick/CyAN documentation built on Oct. 2, 2019, 5:50 p.m.