catalog {rmacrostrat}R Documentation

Retrieve a complete set of definitions

Description

A function to retrieve all definitions and/or metadata for a given definition set. Caution: some datasets are large and may take time to retrieve.

Usage

catalog(type = NULL)

Arguments

type

character. The name of a definition set to retrieve. See Definitions section below for options.

Value

A data.frame containing an exhaustive list of the definitions and/or metadata retrievable for the given definition set. The variables in the data.frame will match those described in the documentation for that definition set.

Definitions

Developer(s)

Bethany Allen & Lewis A. Jones

Reviewer(s)

Lewis A. Jones

Examples


  # Get mineral definitions
  ex1 <- catalog(type = "minerals")
  # Get grain size definitions
  ex2 <- catalog(type = "grain_sizes")


[Package rmacrostrat version 1.0.0 Index]