dcBuildInfoDataFrame: Function to build an object of the S4 class InfoDataframe...

In hfang-bristol/dcGOR: Analysis of Ontologies and Protein Domain Annotations

Function to build an object of the S4 class InfoDataframe from an input file

Description

dcBuildInfoDataFrame is supposed to build an object of of the S4 class InfoDataFrame, given an input file. This input file can, for example, contain the domain information.

Usage

dcBuildInfoDataFrame(input.file, output.file = "InfoDataFrame.RData")

Arguments

input.file

an input file used to build the object. For example, a file containing InterPro domains (InterPro) can be found in http://dcgor.r-forge.r-project.org/data/InterPro/InterPro.txt. As seen in this example, the input file must contain the header (in the first row), and entries in the first column intend to be domain identities (and must be unique). Note: the file should use the tab delimiter as the field separator between columns

output.file

an output file used to save the built object as an RData-formatted file. If NULL, this file will be saved into "InfoDataFrame.RData" in the current working local directory

Value

Any use-specified variable that is given on the right side of the assigement sign '<-', which contains the built dcBuildInfoDataFrame object. Also, an RData file specified in "output.file" is saved in the local directory.

Note

If there are no use-specified variable that is given on the right side of the assigement sign '<-', then no object will be loaded onto the working environment.

See Also

InfoDataFrame

Examples

## Not run: 
# build an "InfoDataFrame" object that contains information on InterPro domains (InterPro)
InterPro <-
dcBuildInfoDataFrame(input.file="http://dcgor.r-forge.r-project.org/data/InterPro/InterPro.txt",
output.file="InterPro.RData")
InterPro

## End(Not run)

hfang-bristol/dcGOR documentation built on July 16, 2022, 6:43 p.m.