get_columns {rmacrostrat} | R Documentation |
Retrieve Macrostrat column data
Description
A function to retrieve independent, hexagonal, vertical columns which contain chronostratigraphically organised Macrostrat units.
Usage
get_columns(
column_id = NULL,
section_id = NULL,
unit_id = NULL,
strat_name = NULL,
strat_name_id = NULL,
interval_name = NULL,
interval_id = NULL,
age = NULL,
age_top = NULL,
age_bottom = NULL,
lat = NULL,
lng = NULL,
lithology = NULL,
lithology_id = NULL,
lithology_type = NULL,
lithology_class = NULL,
lithology_att = NULL,
lithology_att_id = NULL,
lithology_att_type = NULL,
environ = NULL,
environ_id = NULL,
environ_type = NULL,
environ_class = NULL,
pbdb_collection_no = NULL,
econ = NULL,
econ_id = NULL,
econ_type = NULL,
econ_class = NULL,
project_id = NULL,
adjacents = FALSE,
sf = FALSE
)
Arguments
column_id |
|
section_id |
|
unit_id |
|
strat_name |
|
strat_name_id |
|
interval_name |
|
interval_id |
|
age |
|
age_top |
|
age_bottom |
|
lat |
|
lng |
|
lithology |
|
lithology_id |
|
lithology_type |
|
lithology_class |
|
lithology_att |
|
lithology_att_id |
|
lithology_att_type |
|
environ |
|
environ_id |
|
environ_type |
|
environ_class |
|
pbdb_collection_no |
|
econ |
|
econ_id |
|
econ_type |
|
econ_class |
|
project_id |
|
adjacents |
|
sf |
|
Details
More information can be found for the inputs for this function using
the definition functions (beginning with def_
).
Value
A data.frame
containing the following columns:
-
col_id
: The unique identification number of the Macrostrat column. -
col_name
: The name of the Macrostrat column. -
col_group
: Name of the group the column belongs to. Generally corresponds to geologic provinces. -
col_group_id
: The unique identification number of the group to which the column belongs. -
group_col_id
: The original column ID assigned to the column (used in the original source). -
lat
: Decimal degree latitude of the column centroid. -
lng
: Decimal degree longitude of the column centroid. -
col_area
: The area of the Macrostrat column in km2. -
project_id
: The unique identification number for project. Corresponds to general geographic region. -
col_type
: The type of column. -
refs
: The unique identification number(s) for the reference(s) associated with the column. -
max_thick
: The maximum unit thickness in meters. -
max_min_thick
: The maximum possible minimum thickness in meters. -
min_min_thick
: The minimum possible minimum thickness in meters. -
b_age
: The age of the bottom of the column, estimated using the continuous time age model, in millions of years before present. -
t_age
: The age of the top of the column, estimated using the continuous time age model, in millions of years before present. -
b_int_name
: The name of the time interval represented at the bottom of the column. -
t_int_name
: The name of the time interval represented at the top of the column. -
pbdb_collections
: The number of PBDB collections contained within the column. -
lith
: adata.frame
containing the lithologies present within the column, with the following columns:-
name
: The named lithology (e.g., "sandstone"). -
type
: The named lithology type (e.g., "siliciclastic"). -
class
: The named lithology class (e.g., "sedimentary"). -
prop
: The proportion of the lithology within the column, calculated from the individual Macrostrat units within the column. -
lith_id
: The unique identification number of the lithology.
-
-
environ
: adata.frame
containing the environments present within the column, with the following columns:-
name
: The named environment (e.g., "delta plain"). -
type
: The named environment type (e.g., "siliciclastic"). -
class
: The named environment class (e.g., "marine"). -
prop
: The proportion of the environment within the column, calculated from the individual Macrostrat units within the column. -
environ_id
: The unique identification number of the environment.
-
-
econ
: adata.frame
containing the economic attributes present within the column, with the following columns:-
name
: The named economic attribute (e.g., "gold"). -
type
: The named economic attribute type (e.g., "mineral"). -
class
: The named economic attribute class (e.g., "precious commodity"). -
prop
: The proportion of the economic attribute out of all economic attributes contained within the column, calculated from the individual Macrostrat units within the column. -
econ_id
: The unique identification number of the economic attribute.
-
-
t_units
: The total number of units contained within the column. -
t_sections
: The total number of sections contained within the column.
If sf
is TRUE
, an sf
object is returned instead, with the same
columns plus a "geometry" column that contains the spatial data.
Developer(s)
William Gearty
Reviewer(s)
Christopher D. Dean
See Also
Macrostrat data entities:
def_columns()
,
get_age_model()
,
get_sections()
,
get_units()
Examples
# Return columns that overlap with a named chronostratigraphic interval
ex1 <- get_columns(interval_name = "Permian")
# Return columns that overlap with a specified age range
ex2 <- get_columns(age_top = 200, age_bottom = 250)
# Return columns that contain a specific stratigraphic unit, in `sf` format
ex3 <- get_columns(strat_name = "mancos", sf = TRUE)
# Return the columns at a specific geographic coordinate
ex4 <- get_columns(lat = 43, lng = -89, adjacents = TRUE)