def_strat_names {rmacrostrat}R Documentation

Define stratigraphic names

Description

A function to retrieve the definitions for one or more stratigraphic names in the Macrostrat database. By default, all stratigraphic name definitions are returned.

Usage

def_strat_names(
  strat_name = NULL,
  interval_name = NULL,
  rank = NULL,
  concept_id = NULL,
  ref_id = NULL,
  strat_name_id = NULL,
  rule = NULL
)

Arguments

strat_name

character. The name(s) of the desired stratigraphic unit(s) to return a definition for.

interval_name

character. The chronostratigraphic interval name (e.g., "Campanian") for which to return stratigraphic name definitions. This returns strat_names with an age declared in Macrostrat, whose age has any temporal overlap with the desired interval.

rank

character. The formal stratigraphic rank abbreviation of the desired name(s) (i.e., "SGp", "Gp", "SubGp", "Fm", "Mbr", or "Bed") to return a definition for.

concept_id

integer. The unique identification number(s) of the stratigraphic concept(s) (grouped strat_names which represent the same entity) to return a definition for.

ref_id

character. The unique identification number(s) of the desired reference(s). Only stratigraphic names linked to the specified ref_id will be returned.

strat_name_id

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

rule

character. The hierarchical rule for returning stratigraphic name definitions (either "all" or "down"). The "all" option will return the entire stratigraphic name hierarchy (parents and children of all levels) that the requested name(s) belongs to. The "down" option will return any direct children of the requested stratigraphic name(s). Can only be used with strat_name_id.

Value

A data.frame containing the following columns:

Developer(s)

Christopher D. Dean

Reviewer(s)

Bethany Allen

See Also

Stratigraphic names: def_strat_name_concepts()

Examples


# Return a sample of stratigraphic names
ex1 <- def_strat_names()
# Return all stratigraphic names associated with a particular stratigraphic
# name
ex2 <- def_strat_names(strat_name = "Hell Creek")
# Return all stratigraphic names that intersect with a chosen time interval
ex3 <- def_strat_names(interval_name = "Campanian")


[Package rmacrostrat version 1.0.0 Index]