rmacrostrat (version 1.0.0)

def_minerals: Define minerals

Description

A function to retrieve mineral definitions from the Macrostrat database based on user-specified arguments. If no arguments are provided, all definitions are returned.

Usage

def_minerals(mineral = NULL, mineral_type = NULL, element = NULL)

Value

A data.frame containing the following columns:

• mineral_id: The unique identification number of the mineral.

• mineral: The name of the mineral.

• mineral_type: The name of the type of mineral.

• formula: The chemical formula of the mineral.

• formula_tags: The chemical formula of the mineral with appropriate sub/superscript html tags.

• url: A URL for the mineral's entry in Mindat.

• hardness_min: The minimum hardness value (Mohs Hardness Scale) of the mineral.

• hardness_max: The maximum hardness value (Mohs Hardness Scale) of the mineral.

• crystal_form: The crystal form of the mineral.

• mineral_color: A description of the color of the mineral.

• lustre: A description of the lustre of the mineral.

Arguments

mineral

character. The name of a mineral (e.g., "calcite") to return a definition for.

mineral_type

character. The type of mineral (e.g., "feldspar") to return a definition for.

element

character. The chemical element abbreviation of a mineral (e.g., "CaCO3") to return a definition for. Note: abbreviations are case sensitive.

Developer(s)

Lewis A. Jones

Reviewer(s)

Bethany Allen

See Also

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

Examples

# \donttest{
  # Get all mineral definitions
  ex1 <- def_minerals()
  # Get mineral definitions by type
  ex2 <- def_minerals(mineral_type = "element")
# }