def_columns {rmacrostrat}R Documentation

Define Macrostrat columns

Description

A function to retrieve the definitions for Macrostrat columns. By default, all definitions are returned.

Usage

def_columns(
  column_id = NULL,
  column_group_id = NULL,
  column_name = NULL,
  project_id = NULL,
  status = NULL
)

Arguments

column_id

integer. The unique identification number(s) of the desired column(s) to return a definition for.

column_group_id

integer. The unique identification number(s) of the desired column group(s) to return a definition for.

column_name

character. The name of the desired column to return a definition for.

project_id

integer. The unique identification number(s) of the desired Macrostrat project(s) to return a definition for.

status

character. The status of the column to return a definition for. Either "active", "in process", or "obsolete".

Value

A data.frame containing the following columns:

Developer(s)

William Gearty

Reviewer(s)

Christopher D. Dean

See Also

Macrostrat data entities: get_age_model(), get_columns(), get_sections(), get_units()

Examples


# Return all column definitions
ex1 <- def_columns()
# Return subsets of column definitions
ex2 <- def_columns(column_group_id = 17)
ex3 <- def_columns(column_id = c(22,24))
ex4 <- def_columns(column_name = "Eastern Kentucky")


[Package rmacrostrat version 0.0.2 Index]