gm_mean_ci: Returns the Geomean and CI
In mps9506/tbrf: Time-Based Rolling Functions

gm_mean_ci

R Documentation

Returns the Geomean and CI

Description

Generates Geometric mean and confidence intervals using bootstrap.

Usage

gm_mean_ci(
  window,
  conf = 0.95,
  na.rm = TRUE,
  type = "basic",
  R = 1000,
  parallel = "no",
  ncpus = getOption("boot.ncpus", 1L),
  cl = NULL,
  zero.propagate = FALSE
)

Arguments

`window`	vector of data values
`conf`	confidence level of the required interval. `NA` if skipping calculating the bootstrapped CI
`na.rm`	logical `TRUE/FALSE`. Remove NAs from the dataset. Defaults `TRUE`
`type`	character string, one of `c("norm","basic", "stud", "perc", "bca")`. `"all"` is not a valid value. See `boot.ci`
`R`	the number of bootstrap replicates. see `boot`
`parallel`	The type of parallel operation to be used (if any). see `boot`
`ncpus`	integer: number of process to be used in parallel operation. see `boot`
`cl`	optional parallel or snow cluster for use if `parallel = "snow"`. see `boot`
`zero.propagate`	logical `TRUE/FALSE` Allows the optional propagation of zeros.