vizSurfaceShape: Visual Summary of Surface Shape

View source: R/vizSurfaceShape.R

vizSurfaceShapeR Documentation

Visual Summary of Surface Shape

Description

A unique display of surface shape (typically curvature) probability, suitable for across-slope or down-slope shape. Use the title argument to make this clear.

Usage

vizSurfaceShape(
  x,
  title = "Surface Shape",
  s = NULL,
  annotations = TRUE,
  annotation.cex = 0.75,
  cols = c("#2B83BA", "#FFFFBF", "#D7191C", "#808080", "darkgreen"),
  ...
)

Arguments

x

data.frame as created by soilDB::fetchOSD(..., extended=TRUE), see details

title

a reasonable title for the figure

s

an optional soil series name, highlighted in the figure

annotations

logical, add number of record and normalized Shannon entropy values

annotation.cex

annotation label scaling factor

cols

vector of colors

...

additional arguments to ⁠[iterateHydOrder]⁠: ⁠target = 0.9, maxIter = 20, j.amount = 0.05, verbose = FALSE⁠

Details

See the Soil Series Query Functions tutorial for more information.

Value

A list with the following elements:

  • fig: lattice object (the figure)

  • order: 1D ordering from cluster::diana

  • clust: hclust object

  • match.rate: fraction of series matching target hydrologic ordering, after clustering + rotation

Author(s)

D.E. Beaudette


ncss-tech/sharpshootR documentation built on April 9, 2024, 4:27 a.m.