| writeManPage {AnnBuilder} | R Documentation |
The functions are mainly used to write man pages and supporting functions that are needed for a data package
writeManPage(pkgName, pkgPath, manName, organism = "human", src, isEnv =
TURE)
writeMan4Fun(pkgName, pkgPath, organism, QCList)
formatName(toFormat)
writeREADME(pkgPath, pkgName, urls)
writeDescription(pkgName, pkgPath, version, author)
getDSrc(organism)
getSrcNBuilt(dSrc, organism)
getUrlNBuilt(src, organism)
getDSrc{organism}
writeAccessory(pkgName, pkgPath, organism, version, author = c(name =
"who", address = "who@email.net"))
writeFun(pkgPath, pkgName, organism = "human")
writeZZZ(pkgPath, pkgName)
getAllRdaName(pkgName, pkgPath)
escapeLatexChr(item)
writeMan4QC(pkgName, pkgPath)
getExample(pkgName, manName, isEnv = TRUE)
getSrcBuiltNRef(src, organism)
getBuild4Yeast(src, manName)
pkgname |
A character string for the name of a data package or R library |
pkgName |
Same as pkgname |
path |
A character string for the path where pkgname resides |
pkgPath |
Same as path |
elenames |
A vector of character strings for the name of rda files to be produced. The names should be in the first column of AnnInfo.rda in the data subdirectory of AnnBuilder |
organism |
A character string for the name of the organism of interests |
short |
A boolean that is set to TRUE when the man page is for rda files produced by the three functions aforementioned in which case package name will be part of the name of the Rd files to be produced. Otherwise, package name will not be part of the name of the Rd files produced |
fName |
A character string for the name of the Rd file to be produced |
tagName |
A character string for a Latex tag to be written to the Rd file. Valid tags can be found in "Writing R Extensions" |
tagCont |
A character string for the content to be written to a Latex tag |
toFormat |
A character string form whom any underscore will be removed |
urls |
A vector of character of string for the urls of the data source used to create the rda files |
header |
A character string for a short description of an annotation element |
isXML |
A boolean indicating whether header is an XML header (TRUE) or a string (FALSE) |
title |
A character string for the title of an Rd file that is going to be created |
desc |
A character string for the description of the Rd file that is going to be created |
keyword |
A character string for the keyword of the Rd file to be created. The key word must be a standard R keyword |
name |
A character string to be put in a Latex format " |
content |
A character string to be put between the "{}" following "" |
dSrc |
A vector of character strings containing the short names of public data sources (e. g. LL for LocusLink) |
src |
A character string for the short name of a public data source |
filename |
A character string for the name of the to write to |
version |
A character string for the version number |
author |
A named vector of strings with two elements named name and address, respectively. Name is a character string for the name of the person who maintains the data package and address is the email address of the person |
item |
A character string to be escaped by if it is a latex character |
QCList |
A list with statistical data derived from
getDPStats |
manName |
manName a character string for the name of the
man page to be created |
isEnv |
isEnv a boolean to indicate whether the object a
man page concerns is an R environment or not |
If pkgname = "XX" and elenames = "yy", the Rd file will be "XXyy.Rd" appended to the path if short is FALSE. Otherwise, the Rd file will be "yy.Rd" appended to the path.
writeManPage writes a man page for a given object that
is stored in the data directory.
getExample creates a set of example code that is going
to be used in a man page depending on whether the man page is for an
environment object or not.
getSrcBuiltNRef creates the text that is going to be
used for built and reference information in a man page.
getBuild4Yeast creates the text that is going to be used
for built and reference information for the man page for yeast.
All functions return a character string.
The functions are part of the Bioconductor project at Dana-Farber Cancer Institute to provide BioInformatics functionalities through R
Jianhua Zhang
An Introduction to R - Writing R Extensions
makeSrcInfo()
dir.create(file.path(".", "pkg"))
dir.create(file.path(".", "pkg", "data"))
dir.create(file.path(".", "pkg", "man"))
writeManPage("pkg", getwd(), "CHR")
list.files(file.path(getwd(), "pkg", "data"))
unlink("pkg", TRUE)