get_ST_family_classes: Get soil family / series differentiae and class names

Description

All parameters to this function are optional (default NULL). If specified, they are used as filters.

Usage

get_ST_family_classes(
  classname = NULL,
  group = NULL,
  name = NULL,
  chapter = NULL,
  page = NULL,
  multiline_sep = "\n",
  multiline_col = "criteria"
)

Value

a data.frame

a subset of ST_family_classes

data.frame

Arguments

classname: optional filtering vector; levels of ChoiceName column from NASIS metadata
group: optional filtering vector; one or more of: "Mineral Family", "Organic Family", "Mineral or Organic"
name: optional filtering vector; one or more of: "Mineralogy Classes", "Mineralogy Classes Applied Only to Limnic Subgroups", "Mineralogy Classes Applied Only to Terric Subgroups", "Key to the Particle-Size and Substitute Classes of Mineral Soils", "Calcareous and Reaction Classes of Mineral Soils", "Reaction Classes for Organic Soils", "Soil Moisture Subclasses", "Other Family Classes", "Soil Temperature Classes", "Soil Moisture Regimes", "Cation-Exchange Activity Classes", "Use of Human-Altered and Human-Transported Material Classes"
chapter: optional filtering vector for chapter number
page: optional filtering vector; page number (12th Edition Keys to Soil Taxonomy)
multiline_sep: default "\n" returns multiline_col column as a character vector concatenated with "\n". Use NULL for list
multiline_col: character. vector of "multi-line" column names to concatenate. Default: "criteria"; use NULL for no concatenation.

Details

This is a wrapper method around the package data set ST_family_classes.

Examples

Run this code


# get classes in chapter 17
str(get_ST_family_classes(chapter = 17))

# get classes on page 323
get_ST_family_classes(page = 323)

# get the description for the mesic temperature class from list column
str(get_ST_family_classes(classname = "mesic")$description)