def_grain_sizes {rmacrostrat} | R Documentation |
Define grain sizes
Description
A function to return grain size definitions from the Macrostrat Database based on user-specified arguments. If no arguments are specified, all definitions are returned.
Usage
def_grain_sizes(
grain_name = NULL,
grain_group = NULL,
soil_group = NULL,
grain_id = NULL,
grain_symbol = NULL,
grain_classification = NULL
)
Arguments
grain_name |
|
grain_group |
|
soil_group |
|
grain_id |
|
grain_symbol |
|
grain_classification |
|
Value
A data.frame
containing the following columns:
-
grain_id
: The unique identification number of the grain. -
grain_symbol
: The grain symbol (or abbreviation) to use for display purposes. -
grain_name
: The name of the grain. -
grain_group
: The name of the group the grain belongs to. -
soil_group
: The name of the soil family the grain belongs to. -
min_size
: The minimum size of the size in millimeters. -
max_size
: The maximum size of the grain in millimeters. -
classification
: The classification scheme the given grain belongs to.
Developer(s)
Lewis A. Jones
Reviewer(s)
William Gearty
See Also
Geologic features and attributes:
def_econs()
,
def_environments()
,
def_lithologies()
,
def_lithology_att()
,
def_measurements()
,
def_minerals()
,
def_structures()
Examples
# Return all definitions
ex1 <- def_grain_sizes()
# Return grain sizes by group
ex2 <- def_grain_sizes(grain_group = "Gravel")