BuyseTest (version 2.4.0)

getIid: Extract the H-decomposition of the Estimator

Description

Extract the H-decomposition of the GPC estimator.

Usage

getIid(
  object,
  endpoint = NULL,
  statistic = NULL,
  stratified = FALSE,
  cumulative = TRUE,
  center = TRUE,
  scale = TRUE,
  type = "all",
  cluster = NULL
)
# S4 method for S4BuyseTest
getIid(
  object,
  endpoint = NULL,
  statistic = NULL,
  stratified = FALSE,
  cumulative = TRUE,
  center = TRUE,
  scale = TRUE,
  type = "all",
  cluster = NULL
)

Arguments

object

an R object of class S4BuyseTest, i.e., output of BuyseTest

endpoint

[character] for which endpoint(s) the H-decomposition should be output? If NULL returns the sum of the H-decomposition over all endpoints.

statistic

[character] statistic relative to which the H-decomposition should be output.

stratified

[logical] should the H-decomposition relative to the strata-specific statistics be output? Otherwise display the influence function of the global statistic (i.e. over all strata).

cumulative

[logical] should the H-decomposition be cumulated over endpoints? Otherwise display the contribution of each endpoint.

center

[logical] if TRUE the H-decomposition is centered around 0 (estimated statistic is substracted).

scale

[logical] if TRUE the H-decomposition is rescaled (by the sample size in the corresponding arm) such that its sums of squares approximate the variance of the estimator.

type

[character] type of H-decomposition to be output. Can be only for the nuisance parameters ("nuisance"), or for the u-statistic given the nuisance parameters ("u-statistic"), or both.

cluster

[numeric vector] return the H-decomposition aggregated by cluster.

Author

Brice Ozenne

Details

WARNING: argument scale and center should be used with care as when set to FALSE they may not lead to a meaningful decomposition.

See Also

BuyseTest for performing a generalized pairwise comparison.
S4BuyseTest-summary for a more detailed presentation of the S4BuyseTest object.