vizSurfaceShape: Visual Summary of Surface Shape

In sharpshootR: A Soil Survey Toolkit

Visual Summary of Surface Shape

Description

This function creates a graphical summary of surface shape (also described as surface curvature, across or down-slope), as returned by soilDB::fetchOSD(..., extended = TRUE). Stacked barplots are arranged according to an expected hydrologic gradient from "higher" to "lower" relative positions in a theoretical landscape.

Usage

vizSurfaceShape(
  x,
  title = "Surface Shape",
  s = NULL,
  annotations = TRUE,
  annotation.cex = 0.75,
  clust = TRUE,
  dend.size = 5,
  dend.type = c("rectangle", "triangle"),
  cols = c("#3D8399", "#E9D772", "#CF4F3F", "#808080", "#226222"),
  ...
)

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
clust	logical, order rows using divisive hierarchical clustering and include dendrogram?
dend.size	numeric, space reserved for dendrogram when clust = TRUE: values between 3-10 are about right
dend.type	character, one of 'rectangle' or 'triangle', when clust = TRUE
cols	vector of colors
...	additional arguments to iterateHydOrder(): ⁠target = 0.9, maxIter = 20, j.amount = 0.001, verbose = FALSE⁠

Details

See the Soil Series Query Functions tutorial for more information. In the presence of ties within x, a small amount of jittering is applied to proportions to assist with the hydrologic ordering step (only when clust = TRUE).

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

Note

Default colors are from PNWColors::pnw_palette('Bay'). Original colors: c("#2B83BA", "#FFFFBF", "#D7191C", "#808080", "darkgreen").

Author(s)

D.E. Beaudette

sharpshootR documentation built on May 5, 2026, 1:07 a.m.