distStats: Descriptive statistics on intergenic distance data

Description Usage Arguments Value NOTE Author(s) See Also Examples

View source: R/distStats.R

Description

Descriptive statistics on intergenic distance data

Usage

1
2
3
4
5
6
7
distStats(
  GeneSetDistances,
  confLevel = 0.95,
  nboot = 10000,
  CItype = c("bca", "perc"),
  ncores = NULL
)

Arguments

GeneSetDistances

A tibble with intergenic distances for the different gene sets, as generated by the dist2Neighbors function.

confLevel

Confidence level between 0 and 1.

nboot

Integer (Default to 1e4). Number of bootstrap samples.

CItype

Type of confidence interval ("bca" or "perc").

ncores

Number of cores to use for boostrap.

Value

A tibble with the following columns:

NOTE

When nboot is too small and CItype=="bca", the following error can occur: "estimated adjustment 'a' is NA" In this case, use CItype="perc" and/or increase nboot. Using nboot >= 1e4 (the default) is always recommended.

Author(s)

Pascal GP Martin

See Also

boot, boot.ci

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Obtain gene neighborhood information:
  GeneNeighbors <- getGeneNeighborhood(Genegr)
## Get a (random) set of (100) genes:
  set.seed(123)
  randGenes <- sample(names(Genegr), 100)
## Extract distances for this set of genes and for all genes :
 myGeneSets <- list("RandomGenes" = randGenes,
                    "AllGenes" = GeneNeighbors$GeneName)
 distForGeneSets <- dist2Neighbors(GeneNeighbors,
                                   myGeneSets)
## Obtain descriptive statistics for these sets of genes:
distStats(distForGeneSets,
          nboot = 1e3, CItype = "perc", ncores = 1)

pgpmartin/GeneNeighborhood documentation built on Sept. 2, 2021, 6:37 a.m.