External module "stats/padjust/docs/types/index.d"

Export assignment padjust

• padjust(x: Array<number>, method: Method, comparisons?: undefined | number): Array<number>

• Adjusts supplied p-values for multiple comparisons via a specified method.

  Notes

  • The method parameter can be one of the following values:

    • bh: Benjamini-Hochberg procedure controlling the False Discovery Rate (FDR).
    • bonferroni: Bonferroni correction fixing the family-wise error rate by multiplying the p-values with the number of comparisons. The Bonferroni correction is usually a too conservative adjustment compared to the others.
    • by: Procedure by Benjamini & Yekutieli for controlling the False Discovery Rate (FDR) under dependence.
    • holm: Hommel's method controlling family-wise error rate. It is uniformly more powerful than the Bonferroni correction.
    • hommel: Hommel's method, which is valid when hypothesis tests are independent. It is more expensive to compute than the other methods.

  • By default, the number of comparisons for which the p-values should be corrected is equal to the number of provided p-values. Alternatively, it is possible to set comparisons to a number greater than the length of pvals. In that case, the methods assume comparisons - pvals.length unobserved p-values that are greater than all observed p-values (for Holm's method and the Bonferroni correction) or equal to 1 for the remaining methods.

  throws

  comparisons must be greater or equal to the number of elements in pvals

  Parameters

  • x: Array<number>

  • method: Method

    correction method

  • Optional comparisons: undefined | number

    number of comparisons (default: pvals.length)

  Returns Array < number >

  array containing the corrected p-values

  Example

  var pvalues = [ 0.008, 0.03, 0.123, 0.6, 0.2 ];
  var out = padjust( pvalues, 'bonferroni' );
  // returns [ 0.04, 0.15, ..., 1, 1 ]

  Example

  var pvalues = [ 0.008, 0.03, 0.123, 0.6, 0.2 ];
  var out = padjust( pvalues, 'by' );
  // returns [ ~0.091, ~0.171, ..., 1, ~0.571 ]

  Example

  var pvalues = [ 0.008, 0.03, 0.123, 0.6, 0.2 ];
  var out = padjust( pvalues, 'bh' );
  // returns [ 0.04, 0.075, ..., 0.6, 0.25 ]

  Example

  var pvalues = [ 0.008, 0.03, 0.123, 0.6, 0.2 ];
  var out = padjust( pvalues, 'holm' );
  // returns [ 0.04, 0.12, ..., 0.6, 0.4 ]

  Example

  var pvalues = [ 0.008, 0.03, 0.123, 0.6, 0.2 ];
  var out = padjust( pvalues, 'hommel' );
  // returns [ 0.032, 0.12, ..., 0.6, 0.4 ]