Learn R Programming

snpEnrichment (version 1.2-3)

initFiles: Initialize files for enrichment analysis

Description

initFiles create several files needed to run readEnrichment. ".ld", ".frq", ".signal" are created with PLINK. initFiles allow the user to run or not the LD computation with PLINK. LD computation can be run with a new execution of initFiles or with writeLD. When all files are created, this function is not needed anymore. Except if PLINK files (*.bed, *.bim and *.fam) or signalFile has changed.

Usage

initFiles(pattern = "Chrom", snpInfoDir, snpListDir, 
          signalFile, mc.cores = 1)

Arguments

pattern
[character]: character string containing a expression to be matched with all chromosomes files (e.g."Chrom" for files which start by "Chrom" followed by the chromosome number).
snpInfoDir
[character]: character string naming a directory containing the reference data in a PLINK format (*.bed, *.bim and *.fam).
snpListDir
[character]: character string naming a directory containing a list of SNPs for each chromosomes.
signalFile
[character]: the name of the signal file which the data are to be read from (2 columns: "SNP" and "PVALUE"). Each row of the table appears as one line of the file. If it does not contain an _absolute_ path, the file name is _re
mc.cores
[numeric]: The number of cores to use (default is mc.cores=1), i.e. at most how many child processes will be run simultaneously. Must be at least one, and parallelization requires at least two cores.

Value

  • This function writes several files, in the temporary directory (defined in R_SESSION_TMPDIR), nothing else is returned. These files are used to build an Enrichment object by readEnrichment in order to compute enrichment analysis (reSample).

See Also

Overview : snpEnrichment-package Classes : Enrichment, Chromosome, EnrichSNP Methods : plot, reSample, excludeSNP, compareEnrichment, enrichment, is.enrichment, chromosome, is.chromosome Functions : initFiles, writeLD, readEnrichment

Examples

Run this code
snpInfoDir <- system.file("extdata/snpInfo", 
                          package = "snpEnrichment")
signalFile <- system.file("extdata/Signal/toySignal.txt", 
                          package = "snpEnrichment")
snpListDir <- system.file("extdata/List", 
                          package = "snpEnrichment")
initFiles(pattern = "Chrom", 
          snpInfoDir, 
          snpListDir, 
          signalFile, 
          mc.cores = 1)

Run the code above in your browser using DataLab