geneSet.intersects {background} R Documentation

get an intersection id list between the background

Description

model and the given gene id list.

Usage

geneSet.intersects(cluster, geneSet,
    isLocusTag = FALSE,
    get.clusterID = FALSE,
    term.map = FALSE,
    id.map = FALSE);

Arguments

cluster

A gene cluster model or gsea background model object.

geneSet

a character vector of the gene ids for the intersection query. [as string]

isLocusTag

matches the gene id with the locus tag instead of the accession id? Default FALSE. [as boolean]

get.clusterID

this function will returns a set of mapping cluster id if this parameter value is set to value TRUE, otherwise this function returns a set of intersected geneID list by default.

this parameter only works when the cluster object is a gsea background model object. [as boolean]

term.map

returns a dataframe of the gene id and the annotation term of each gene instead of the intersected id set when this parameter is set to TRUE. Default FALSE. [as boolean]

id.map

keeps the original gene id in the term column of the result dataframe when the gene has no annotation term? Default FALSE means the empty value will be used. [as boolean]

env

the R# runtime environment. [as Environment]

Details

Authors

gseakit

Value

a character vector of the intersected gene id set or the cluster id set based on the option of parameter get_clusterID.

clr value class

Examples

 let kb = read.background("kegg_background.xml");
 let idset = c("id1","id2","id3");
 
 print("intersect gene ids:");
 print(kb |> geneSet.intersects(idset));
 
 print("intersect cluster ids:");
 print(kb |> geneSet.intersects(idset, get_clusterID=TRUE));

[Package background version 1.0.0.0 Index]