Search: "Search"

Description Usage Arguments Value

View source: R/Functions.R

Description

The Search function investigates whether specific genes and/or exons are present in the data. It returns the elements of the found elements and a list of those that were not found.

Usage

1
2
Search(WhatToLookFor = data.frame(GeneID = NULL, ExonID = NULL), Data,
  AggregateResults = FALSE, NotFound = NULL)

Arguments

WhatToLookFor

A data frame with a GeneID and ExonID column. Only the ExonID column is necessary, the corresponding gene ID will be sought in the data

Data

The data in which the given gene and exon ID should be sought.

AggregateResults

Logical. Should the results be aggregated on gene level? This results in a list with one item per gene

NotFound

Not be specified by the user.

Value

The returned value is a list with two elements. The first element is SearchResults which contains a list of the found intstances in the data. The list contains an element per found instance. If AggregateResults is TRUE, the list is reduced to an element per gene. The secod is a data frame calles NotFound which contain the gene and exon ID which were not found in the data. If only exon ID were specified, the gene ID are NA in this data frame.


REIDS documentation built on May 2, 2019, 4:45 p.m.