R语言 PAnnBuilder包 writeManPage()函数中文帮助文档(中英文对照)

loveR

writeManPage(PAnnBuilder)
writeManPage()所属R语言包：PAnnBuilder

                                        Write Help Documents
                                         写帮助文档

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

Given the R environment in the data directory, these functions write help documents based on templates and stored them in the man directory.
鉴于R环境中的数据目录，这些功能编写基于模板和存储在男子目录帮助文档。


用法----------Usage----------


getRepList(organism="", type, srcUrls="", built="", pkgName)
copyTemplates(repList, pattern, pkgName, pkgPath, replaceBy = NULL)
copyTemplates_DB(repList, pkgName, pkgPath)
writeDescription(pkgName, pkgPath, version, author,
                 dataSrc = "public data repositories",
                 license = "The Artistic License, Version 2.0")  
writeDescription_DB(pkgName, pkgPath, version, author, organism,
                    dataSrc = "public data repositories",
                    license = "The Artistic License, Version 2.0")
   
writeManAnno(pkgName, pkgPath, version, author, repList, pattern)
writeManAnno_DB(pkgName, pkgPath, version, author, repList)
writeManSQ(pkgName, pkgPath, version, author, repList)
writeManMerge(pkgName, pkgPath, version, author, repList, pattern)



参数----------Arguments----------

参数：organism
a character string for the name of the organism of concern. (eg: "Homo sapiens")
为关注的有机体的名称的字符串。 （例如：“智人”）


参数：type
a character string for the concerned database. Possible values of  type are : "sp", "trembl", "ipi", "refseq", "geneint", "intact", "mppi",  "3DID", "DOMINE", "BaCelLo", "DBSubLoc", "SCOP", "HomoloGene", "InParanoid",  "PeptideAtlas", "SysPTM", "SysBodyFluid", "GOA", "GO", "KEGGNAME", "PFAMNAME",  "INTERPRONAME", "TAXNAME", "dName", "cross", "pSeq".  
一个有关数据库的字符串。可能的值的类型是：“SP”，“TrEMBL这”，“IPI”，“的RefSeq”，“geneint”，“完整”，“MPPI”，“3DID”，“DOMINE” “BaCelLo”，“DBSubLoc”，“SCOP的”，“HomoloGene”，“INPARANOID”，“PeptideAtlas”，“SysPTM”，“SysBodyFluid的”，“兴亚”，“GO” ，“KEGGNAME”，“PFAMNAME”，“INTERPRONAME”，“TAXNAME”，“DNAME”，“叉乘”，“PSEQ”。


参数：srcUrls
a character string or a string vector for the urls of database.
数据库的URL字符串或一个字符串向量。


参数：built
a character string for the version/release information of database.
一个数据库版本/发布信息的字符串。


参数：repList
a named list which will replace the symbols in template file.
一个名为列表将取代在模板文件中的符号。


参数：pattern
a character string of the prefix of template *.Rd file  
号文件的模板*的前缀字符串。


参数：replaceBy
a character string for the prefix of new *.Rd file.  If replaceBy=NULL, pattern will be replaed by pkgName. Otherwise  pattern will be replaed by replaceBy  
一个新的*。号文件的前缀字符串。如果replaceBy = NULL，图案将被replaed的PKGNAME。否则的格局将被replaed由replaceBy


参数：dataSrc
a character string describing the data source
字符串描述数据源


参数：license
a character string describing the license of R package.  It will appear in the description file.
一个字符串，描述了R包的许可证。它会出现在描述文件。


参数：pkgName
the name of the data package to be built. (e.g. "hsaSP")  
要建立的数据包的名称。 （例如“hsaSP”）


参数：pkgPath
a character string for the full path of an existing directory where the built backage will be stored.   
为建backage将存储现有目录的完整路径的字符串。


参数：version
a character string for the version number.
一个版本号的字符串。


参数：author
a list with named elements "authors" containing a character vector of author names and "maintainer" containing the complete character string for the maintainer field, for example, "Jane Doe <jdoe@doe.com>".   
与元素命名为“作者”包含作者姓名的特征向量和“维护者”，含有完整的字符串维护者领域，例如，“Jane Doe的<jdoe@doe.com>”的名单。


Details

详情----------Details----------

Write help document files for the package. getRepList return a list which will replace the symbols in  template file.
写帮助文档文件包。 getRepList返回一个列表，将取代在模板文件中的符号。

If the name of "*.rda" file in the "data" subdirectory matchs the pattern,  copyTemplates will produce a "*.rd" file in the "man"  subdirectory. Related template files in the "inst/templates" subdirectory  are needed for this function.
如果“*。RDA”中的“数据”模式的子目录配文件的名称，copyTemplates会产生一个“*号”文件中的“人”的子目录。在“出师表/模板”相关的模板文件的子目录都需要此功能。

Parameter "names" gives the name of the data objects; copyTemplates_DB  will produces relative "*.rd" files in the "man" subdirectory. Related template  files in the "inst/templates" subdirectory are needed for this function.
参数“名称”提供的数据对象的名称;copyTemplates_DB会产生相对的“人”的子目录中的文件“*路”。在“出师表/模板”相关的模板文件的子目录都需要此功能。

writeDescription write descrption file for the environment-based  annotation package.
writeDescription写环境为基础的注解包之描述文件。

writeDescription_DB write descrption file for the SQLite-based   annotation package.   
writeDescription_DB写的SQLite为基础的注解包之描述文件。

writeManAnno write help document files for the environment-based  annotation package. writeManAnno_DB write help document files for the SQLite-based  annotation package.
writeManAnno写环境为基础的注解包帮助文档文件。 writeManAnno_DB写的SQLite为基础的注解包帮助文档文件。

writeManSQ write help document files for the sequence data  package.
writeManSQ写序列数据包帮助文档文件。

writeManMerge  write help document files for the merged package.
writeManMerge写帮助文档文件，合并后的包。


作者（S）----------Author(s)----------


Hong Li



参考文献----------References----------

assembling annotation for genomic data.Bioinformatics 19(1), 155-156.
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。