get_map_legends {rmacrostrat}R Documentation

Retrieve geologic map legend data

Description

A function to retrieve legend components from various geological maps.

Usage

get_map_legends(
  source_id = NULL,
  lithology_id = NULL,
  lithology_type = NULL,
  lithology_class = NULL,
  description = NULL,
  comments = NULL,
  scale = NULL,
  carto = NULL
)

Arguments

source_id

integer. Filter legend components to those in sources specified by their unique identification number(s).

lithology_id

integer. Filter legend components to those containing one or more lithology(ies) as specified by their unique identification number(s).

lithology_type

character. Filter legend components to those containing one or more named lithology type(s) (e.g., "carbonate", "siliciclastic").

lithology_class

character. Filter legend components to those containing one or more named lithology class(es) (e.g., "sedimentary", "igneous", "metamorphic").

description

character. Filter legend components to those containing the given character string in the map unit description field.

comments

character. Filter legend components to those containing the given character string in the map unit comments field.

scale

character. Filter legend components to those from maps of specific scale(s) in Macrostrat's system. Options are "tiny" (global), "small" (continental), "medium" (regional), or "large" (local).

carto

character. Filter legend components to those of specific scale(s) in Macrostrat's system. Options are "tiny" (global), "small" (continental), "medium" (regional), or "large" (local).

Details

Potential Macrostrat map scales are "tiny" (global), "small" (continental), "medium" (regional), or "large" (local).

Value

A dataframe containing the following columns:

Developer(s)

Christopher D. Dean

Reviewer(s)

William Gearty

See Also

Geologic maps: def_sources(), get_map_outcrop(), get_map_points()

Examples


 # Get legend components by ID of the original source map
 ex1 <- get_map_legends(source_id = 1)
 # Get legend components for any sedimentary lithologies
 ex2 <- get_map_legends(lithology_type = "sedimentary")
 # Get any legend components that have comments with the word 'breccia'
 ex3 <- get_map_legends(comments = "breccia")


[Package rmacrostrat version 0.0.2 Index]