summary.OpenStatsRR: Summary for an OpenStatsRR object

In mpi2/OpenStats: A Robust and Scalable Software Package for Reproducible Analysis of High-Throughput genotype-phenotype association

Summary for an OpenStatsRR object

Description

This function provides summary for an OpenStatsRR object

Usage

 ## S3 method for class 'OpenStatsRR'
summary(object, format = "rst", ...)

Arguments

object	an instance of OpenStatsRR result from OpenStatsAnalysis(method = 'RR') function
format	See format argument from the knitr::kable function
...	Other parameters that can be passed to knitr::kable function

Value

The output consists of a pair of values separated by comma, e.g. 1,1, for low and high classes respectively. The following statistics are reported in the summary:

- Applied model
- Checked/optimised model
- Treatment group
- Control group
- If possible, whether sexual dimorphism is detected from the analysis
- Genotype effect p-value
- Genotype effect p-value for females
- Genotype effect p-value for males
- If LifeStage existed in the data, LifeStage p-value
- Genotype effect for early adults
- Genotype effect for late adults
- If Sex existed in the data, Sex p-value
- If bodyweight existed in the data, bodyweight p-value

Author(s)

Hamed Haseli Mashhadi <[e-mail]>

See Also

OpenStatsAnalysis, summary.OpenStatsFE, summary.OpenStatsMM

Examples

####################################################################
# Data preparation
####################################################################
#################
# Continuous data - Creating OpenStatsList object
#################
fileCon <- system.file("extdata", "test_continuous.csv", package = "OpenStats")
test_Cont <- OpenStatsList(
  dataset = read.csv(fileCon),
  testGenotype = "experimental",
  refGenotype = "control",
  dataset.colname.genotype = "biological_sample_group",
  dataset.colname.batch = "date_of_experiment",
  dataset.colname.lifestage = NULL,
  dataset.colname.weight = "weight",
  dataset.colname.sex = "sex"
)

#################
# Reference range framework
#################
RR_result <- OpenStatsAnalysis(
  OpenStatsList = test_Cont,
  method = "RR",
  RR_formula = data_point ~ Genotype + Sex
)
summary(RR_result)

mpi2/OpenStats documentation built on Sept. 17, 2022, 3:58 p.m.