Marginal statistics of a profile population

Reduces the realizations of simulateSoilProfiles(), of propagateSitePeriod(), of propagateBeamPeriod() or of any table with one row per realization to the requested quantiles and mean of the named numeric properties. The statistics are marginal: a quantile row does not describe one column, and the pairing between properties is lost in this reduction. Keep the realization table when a later calculation needs paired values.

Usage

summarizeProfiles(profiles, levels, properties)

Arguments

profiles

A table with one row per realization.

levels

Probabilities in (0, 1) and/or the literal "mean", in the order the rows are wanted.

properties

Names of the numeric columns of profiles to summarize, for example c("Go", "mo", "VSo"), "Tr" or "Ts".

Value

A data.table with one row per requested level: level (the probability as text, or "mean"), n (realizations summarized) and the requested properties. Quantiles use type 7 of stats::quantile() on the stored values; the mean is arithmetic.

Examples

set.seed(20260915)
Profiles <- simulateSoilProfiles(Hs = 10, USCS = c("ML", "MH"), NS = 5, h = 1,
                                 water = 0, POP = 100, Vref = 760)
summarizeProfiles(Profiles, levels = c(0.16, "mean", 0.84), properties = c("Go", "mo", "VSo"))
#>     level     n       Go        mo      VSo
#>    <char> <int>    <num>     <num>    <num>
#> 1:   0.16     5 65.91156 0.3611075 183.3256
#> 2:   mean     5 70.82883 0.4410952 190.2767
#> 3:   0.84     5 76.11136 0.5442644 195.8575