vizHillslopePosition: Visual Summary of Hillslope Position

View source: R/vizHillslopePosition.R

vizHillslopePositionR Documentation

Visual Summary of Hillslope Position

Description

A unique display of hillslope position probability.

Usage

vizHillslopePosition(
  x,
  s = NULL,
  annotations = TRUE,
  annotation.cex = 0.75,
  cols = c("#2B83BA", "#ABDDA4", "#FFFFBF", "#FDAE61", "#D7191C"),
  ...
)

Arguments

x

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

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


sharpshootR documentation built on Aug. 24, 2023, 5:07 p.m.