clusterSPconfig function

Configure clusterSP computation

Configure clusterSP computation

Configure the (hyper)parameters to computing snow profile clusters.

clusterSPconfig( type = "n", simType = NULL, ddate = FALSE, pwls = FALSE, n_cores = NULL, verbose = TRUE )

Arguments

  • type: which method of clustering, current options are kdba or default n which provides generic config
  • simType: which profile similarity method is used for alignments, see simSP for options
  • ddate: if profiles contain deposition date adjust the dimensions and weights used for layer similarities passed to distanceSPlayers
  • pwls: if profiles contain stability indices then use that information to classify PWLS in averageSP
  • n_cores: number of nodes passed to averageSP and distanceSP to run calculations in parallel, default NULL performs all calculations in serial
  • verbose: logical indicating whether to print various diagnostics

Returns

a list containing the following:

  • args_distance: a parameter list passed on to the distance function during clustering. This list will determine the distance computation in clustering type 'kdba', and the computation of a distance matrix with distanceSP for other clustering types
  • args_centers: a parameter list passed on to clusterSPcenters during clustering
  • args_cluster: a parameter list passed onto the clustering functions stats::hclust , cluster::pam , cluster::fanny , clusterSPkdba
  • args_fast: a named vectors with weights for summary stats used in in fast option
  • verbose: copied from the input parameter verbose

Examples

print(clusterSPconfig(ddate = TRUE))

See Also

clusterSP

Author(s)

fherla shorton