ghap.subset {GHap}

Subset GHap objects

Description

This function takes a list of variants and individuals and subsets a GHap object.

Usage

ghap.subset(object, ids, variants,
            index=FALSE, verbose=TRUE)

Arguments

object

A valid GHap object (phase, haplo or plink).

ids

A character or numeric vector indicating individuals to parse.

variants

A character or numeric vector indicating variants to parse. If a "GHap.haplo" object is provided, the vector must be numeric.

index

A logical value specfying if values provided for ids and variants are indices (see details).

verbose

A logical value specfying whether log messages should be printed (default = TRUE).

Details

This function sets to FALSE (i.e., inactivates) all individuals and variants not included in the provided arguments. This procedure avoids expensive subsetting operations by simply flagging which variants and individuals should be used in downstream analyses. The argument index allows the user to specify individuals either by name (index = FALSE) or by indices as stored in the GHap object (index = TRUE). In the case of "GHap.haplo" objects, HapAlleles can only by parsed via indices.

Value

A GHap object of the same type as the one used in the object argument.

Author(s)

Yuri Tani Utsunomiya <[e-mail]>

Examples

# #### DO NOT RUN IF NOT NECESSARY ###
# 
# # Copy phase data in the current working directory
# exfiles <- ghap.makefile(dataset = "example",
#                          format = "phase",
#                          verbose = TRUE)
# file.copy(from = exfiles, to = "./")
# 
# # Load data
# phase <- ghap.loadphase("example")
# 
# ### RUN ###
# 
# # Subset individuals from population 'Pure1'
# pure1 <- unique(phase$id[which(phase$pop == "Pure1")])
# phase <- ghap.subset(object = phase, ids = pure1,
#                      variants = phase$marker)
# 
# # Calculate allele frequencies for population 'Pure1'
# freq <- ghap.freq(phase, type = 'maf')
# 
# # Subset markers with MAF > 0.05 in population 'Pure1'
# mkr <- names(freq)[which(freq > 0.05)]
# phase <- ghap.subset(object = phase, ids = pure1,
#                      variants = mkr)