OSDquery: Search full text of Official Series Description on SoilWeb

View source: R/OSDquery.R

OSDqueryR Documentation

Search full text of Official Series Description on SoilWeb

Description

This is the R interface to OSD search by Section and OSD Search APIs provided by SoilWeb.

OSD records are searched with the PostgreSQL fulltext indexing and query system (syntax details). Each search field (except for the "brief narrative" and MLRA) corresponds with a section header in an OSD. The results may not include every OSD due to formatting errors and typos. Results are scored based on the number of times search terms match words in associated sections.

Usage

OSDquery(
  everything = NULL,
  mlra = "",
  taxonomic_class = "",
  typical_pedon = "",
  brief_narrative = "",
  ric = "",
  use_and_veg = "",
  competing_series = "",
  geog_location = "",
  geog_assoc_soils = ""
)

Arguments

everything

search entire OSD text (default is NULL), mlra may also be specified, all other arguments are ignored

mlra

a comma-delimited string of MLRA to search ('17,18,22A')

taxonomic_class

search family level classification

typical_pedon

search typical pedon section

brief_narrative

search brief narrative

ric

search range in characteristics section

use_and_veg

search use and vegetation section

competing_series

search competing series section

geog_location

search geographic setting section

geog_assoc_soils

search geographically associated soils section

Details

See this webpage for more information.

  • family level taxa are derived from SC database, not parsed OSD records

  • MLRA are derived via spatial intersection (SSURGO x MLRA polygons)

  • MLRA-filtering is only possible for series used in the current SSURGO snapshot (component name)

  • logical AND: &

  • logical OR: |

  • wildcard, e.g. rhy-something rhy:*

  • search terms with spaces need doubled single quotes: ”san joaquin”

  • combine search terms into a single expression: (grano:* | granite)

Related documentation can be found in the following tutorials

Value

a data.frame object containing soil series names that match patterns supplied as arguments.

Note

SoilWeb maintains a snapshot of the Official Series Description data.

Author(s)

D.E. Beaudette

References

USDA-NRCS OSD search tools: https://soilseries.sc.egov.usda.gov/

See Also

fetchOSD, siblings, fetchOSD

Examples





  # find all series that list Pardee as a geographically associated soil.
  s <- OSDquery(geog_assoc_soils = 'pardee')

  # get data for these series
  x <- fetchOSD(s$series, extended = TRUE, colorState = 'dry')

  # simple figure
  par(mar=c(0,0,1,1))
  plot(x$SPC)



soilDB documentation built on Sept. 11, 2024, 8:28 p.m.