get_ST_features: Get soil diagnostic horizons, characteristics and features

View source: R/diagnostic-features.R

get_ST_featuresR Documentation

Get soil diagnostic horizons, characteristics and features

Description

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

Usage

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

Arguments

group

optional filtering vector; one of: "Surface", "Subsurface", "Mineral", "Organic", "Mineral or Organic"

chapter

optional filtering vector for chapter number

name

optional filtering vector; these are the "names" of features used in headers

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_features.

Value

a subset of ST_features data.frame

See Also

ST_features ST_family_classes get_ST_family_classes()

Examples


# get all features
str(get_ST_features())

# get features in chapter 3
str(get_ST_features(chapter = 3))

# get features on pages 18, 19, 20
get_ST_features(page = 18:20)

# get the required characteristics for the mollic epipedon from list column
str(get_ST_features(name = "Mollic Epipedon")$criteria)


SoilTaxonomy documentation built on Nov. 17, 2023, 1:07 a.m.