writeXMLHeader {AnnBuilder}R Documentation

A function to write header information to an XML file.

Description

This function writes to the Attr node of an annotate XML file.

Usage

writeXMLHeader(outName, fileCol, name, version, organism="human")

Arguments

outName A character string for the name of the XML file to store the generated mata-data.
fileCol A vector of character strings for the names of data columns in the original file that is going to be used to produce the Data node of the XML file.
name A character string for an internal name that is normally the target of the annotation (e. g. U95 for the u95 chip).
version A character string or number for the version of the system that produces the XML file.
organism A character string for the name of the organism of interests

Details

The XML file produced has an Attr node to hold the header information. The Attr node contains a Target node for the internal name, a DataMade node to date the file when it is made, one to many SourceFile nodes for names of the source files used for annotation, and one to many Element nodes for names of the data items the Data node of the XML will contain.

Value

This function does not return any value.

Note

This function is part of the Bioconductor project at Dana-Farber Cancer Institute to provide Bioinformatics functionalities through R.

Author(s)

Jianhua (John) Zhang

References

http://www.bioconductor.org/datafiles/dtds/annotate.dtd

See Also

fileToXML

Examples

makeSrcInfo()
#Write the header to a temp file
if(interactive()){
writeXMLHeader(outName = "try.xml", fileCol = c("AFFY", "LOCUSID",
"ACCNUM"), name = "Not Real", version = "0.5", organism = "human")
# View the header
readLines("try.xml")
# Clearn up
unlink("try.xml")
}

[Package AnnBuilder version 1.4.21 Index]