SSMD.census: Compare census values against a baseline scenario.

Description Usage Arguments Details Value References

View source: R/HexSimR.R

Description

SSMD.census carries out pairwise comparisons of the census values against a baseline scenario using Strictly Standardised Mean Difference (SSMD, Zhang 2007).

Usage

1
2
3
4
5
6
7
SSMD.census(
  path.results = NULL,
  scenarios = "all",
  base = NULL,
  ncensus = 0,
  keep.zeros = "TRUE"
)

Arguments

path.results

The path to the 'Results' folder

scenarios

A character vector with the scenarios to be processed or "all"

base

A character vector with the name of the scenario to be used as term of comparison

ncensus

The number of the census to be considered

keep.zeros

Whether zeros were kept or not when census files were collated

Details

It takes as data input the output from collate.census (it reads data directly from xls files). The argument keep.zeros needs to be set exactly as it was in collate.census call.

Value

A list with SSMD in the first element and p-values in the second. These results are also saved to disk as two tabs in an excel file named "SSMD_census[ncensus].xlsx", where [ncensus] is the number of the census file.

References

Zhang, X. D. 2007. A pair of new statistical parameters for quality control in RNA interference high-throughput screening assays. Genomics 89:552-561.


carlopacioni/HexSimR documentation built on Nov. 28, 2020, 4:12 p.m.