def_lithologies {rmacrostrat}R Documentation

Define lithologies

Description

A function to retrieve the definitions of one or more lithologies in the Macrostrat database. If no arguments are specified (the default), all lithology definitions are returned.

Usage

def_lithologies(
  lithology = NULL,
  lithology_group = NULL,
  lithology_class = NULL,
  lithology_type = NULL,
  lithology_id = NULL
)

Arguments

lithology

character. The name of the desired lithology (e.g., "limestone") to return a definition for.

lithology_group

character. The name of the desired lithological group (e.g., "unconsolidated") to return a definition for.

lithology_class

character. The name of the desired lithological class (e.g., "sedimentary") to return a definition for.

lithology_type

character. The name of the desired lithological type (e.g., "siliciclastic") to return a definition for.

lithology_id

integer. The unique identification number(s) of one or more lithologies to return a definition for.

Value

A data.frame containing the following columns:

Developer(s)

William Gearty

Reviewer(s)

Bethany Allen

See Also

Geologic features and attributes: def_econs(), def_environments(), def_grain_sizes(), def_lithology_att(), def_measurements(), def_minerals(), def_structures()

Examples


# return all lithology definitions
ex1 <- def_lithologies()
# return a definition for sandstone
ex2 <- def_lithologies(lithology = "sandstone")
# return definitions for lithologies of a specific type
ex3 <- def_lithologies(lithology_type = "sedimentary")
# return definitions for lithologies using their unique ID numbers
ex4 <- def_lithologies(lithology_id = c(1,5))


[Package rmacrostrat version 0.0.2 Index]