summary.S2CFA: S3 Summary for S2CFA

Description

S3 summary method for object of class"S2CFA"

Usage

# S3 method for S2CFA
summary(
  object,
  digits = 3,
  type = "ex.fisher.test",
  sorton = NULL,
  decreasing = FALSE,
  showall = TRUE,
  adjalpha = "bonferroni",
  ...
)

Value

a summary of the results printed on the console.

Arguments

object: object of class"S2CFA"
digits: integer rounds the values to the specified number of decimal places, default is digits=3.
type: character with default type="ex.fisher.test", to return wether the observed pattern are 'discriminating Types' or not significant at all based on the respective p-value. Another option for type is type="pChi".
sorton: sort results of local test by any column. By default the output is not sorted. Other options may be "pat.", "disc.Type", etc. ... So all column names that can potentially appear in the result.
decreasing: logical. Should the sort be increasing or decreasing? see order
showall: logical with default showall = TRUE. To return only significant pattern (discriminating types) set it to showall = FALSE.
adjalpha: character with default adjalpha = "bonferroni". Selector for the type of alpha adjustment for multiple testing. Possible options are: adjalpha = "none", for no adjustment; adjalpha = "bonferroni", for bonferroni adjustment (default); adjalpha = "holm", for alpha adjustment according to Holm (1979); other options to come ... .
...: other parameters passed trough.

References

Holm, S. (1979). A simple sequentially rejective multiple test procedure. Scandinavian Journal of Statistics, 6(2), 65–70.

Bonferroni, C. E. (1935). Il calcolo delle assicurazioni su gruppi di teste. In S.O. Carboni (Ed.), Studi in Onore del Professore Salvatore Ortu Carboni (S. 13–60). Roma, Tipografia del Senato: Bardi.