createSummaryTableFromEnsembleTable: Create a summary table from an ensemble table

In nickmckay/GeoChronR: Tools to Analyze and Visualize Time-Uncertain Data

Create a summary table from an ensemble table

Description

Create a summary table from an ensemble table

Usage

createSummaryTableFromEnsembleTable(
  L,
  paleo.or.chron = "chronData",
  paleo.or.chron.num = NA,
  model.num = NA,
  ens.table.num = NA,
  ens.var = "ageEnsemble",
  probs = c(0.025, 0.25, 0.5, 0.75, 0.975),
  prob.vars = c("unc2.5", "unc25", "ageMedian", "unc75", "unc97.5"),
  depth.var = "depth"
)

Arguments

L	A LiPD object - an R serialization of a single LiPD file. It's a list, and is typically created by 'readLipd()'
paleo.or.chron	"paleoData" or "chronData"
paleo.or.chron.num	an integer that corresponds to paleo.num or chron Data object (L$<paleo.or.chron>[[?]]) has the variable you want?
model.num	an integer that corresponds to model.num that has the variable you want
ens.table.num	an integer that corresponds to ensembleTable you want to get the variable from?
ens.var	The name of the ensemble variable (default = "ageEnsemble")
probs	A vector of probabilites (quantiles) should be computed for the summary? (default = c(0.025,0.25,.5,.75,.975))
prob.vars	A vector of variableNames for the probabilites in probs (default = c("unc2.5","unc25","ageMedian","unc75","unc97.5"))
depth.var	The name of the depth (or position) variable in the ensemble table (default = "depth")

Value

A LiPD object with an added ensemble table

See Also

Other LiPD manipulation: createConcatenatedEnsembleMeasurementTable(), createModel(), createMultiModelEnsemble(), createTSid(), estimateUncertaintyFromRange(), getVariableIndex(), mapAgeEnsembleToPaleoData(), pullTsVariable(), selectData()

nickmckay/GeoChronR documentation built on April 9, 2024, 5:26 a.m.