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

loveR

BSgenomeForge(BSgenome)
BSgenomeForge()所属R语言包：BSgenome

                                        The BSgenomeForge functions
                                         BSgenomeForge功能

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

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

A set of functions for making a BSgenome data package.
一个包BSgenome的数据集的功能。


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


## Top-level BSgenomeForge function:

forgeBSgenomeDataPkg(x, seqs_srcdir=".", masks_srcdir=".", destdir=".", verbose=TRUE)

## Low-level BSgenomeForge functions:

forgeSeqlengthsFile(seqnames, prefix="", suffix=".fa",
                    seqs_srcdir=".", seqs_destdir=".", verbose=TRUE)

forgeSeqFiles(seqnames, mseqnames=NULL, prefix="", suffix=".fa",
              seqs_srcdir=".", seqs_destdir=".", verbose=TRUE)

forgeMasksFiles(seqnames, nmask_per_seq,
                seqs_destdir=".", masks_srcdir=".", masks_destdir=".",
                AGAPSfiles_type="gap", AGAPSfiles_name=NA,
                AGAPSfiles_prefix="", AGAPSfiles_suffix="_gap.txt",
                RMfiles_name=NA, RMfiles_prefix="", RMfiles_suffix=".fa.out",
                TRFfiles_name=NA, TRFfiles_prefix="", TRFfiles_suffix=".bed",
                verbose=TRUE)



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

参数：x
A BSgenomeDataPkgSeed object or the name of a BSgenome data package seed file. See the BSgenomeForge vignette in this package for more information.  
一个BSgenomeDataPkgSeed对象或一个BSgenome数据包种子文件的名称。在这个包的更多信息，请参见BSgenomeForge暗角。


参数：seqs_srcdir, masks_srcdir
Single strings indicating the path to the source directories i.e. to the directories containing the source data files. Only read access to these directories is needed. See the BSgenomeForge vignette in this package for more information.  
表明单一的来源，即包含源数据文件的目录的目录的路径字符串。只读取这些目录的访问是必要的。在这个包的更多信息，请参见BSgenomeForge暗角。


参数：destdir
A single string indicating the path to the directory where the source tree of the target package should be created. This directory must already exist. See the BSgenomeForge vignette in this package for more information.  
一个单一的字符串，表示应建立目标包的源代码树的目录路径。这个目录必须已经存在。在这个包的更多信息，请参见BSgenomeForge暗角。


参数：verbose
TRUE or FALSE.  
TRUE或FALSE。


参数：seqnames, mseqnames
A character vector containing the names of the single (for seqnames) and multiple (for mseqnames) sequences to forge. See the BSgenomeForge vignette in this package for more information.  
一个特征向量含有单（seqnames）和多个（mseqnames）序列伪造的名称。在这个包的更多信息，请参见BSgenomeForge暗角。


参数：prefix, suffix
See the BSgenomeForge vignette in this package for more information, in particular the description of the seqfiles_prefix and seqfiles_suffix fields of a BSgenome data package seed file.  
看到这包的更多信息BSgenomeForge小插曲，在特别的说明，seqfiles_prefix和seqfiles_suffix一个BSgenome数据包种子文件领域。


参数：seqs_destdir, masks_destdir
During the forging process the source data files are converted into serialized Biostrings objects. seqs_destdir and masks_destdir must be single strings indicating the path to the directories where these serialized objects should be saved. These directories must already exist.  forgeSeqlengthsFile will produce a single .rda file. Both forgeSeqFiles and forgeMasksFiles will produce one .rda file per sequence.  
在锻造过程中的源数据文件转换到序列Biostrings对象。 seqs_destdir和masks_destdir必须是单一的字符串表明这些序列化的对象应保存的目录的路径。这些目录必须已经存在。 forgeSeqlengthsFile会产生一个单一的。RDA文件。既forgeSeqFiles和forgeMasksFiles会产生每一个序列。RDA文件。


参数：nmask_per_seq
A single integer indicating the desired number of masks per sequence. See the BSgenomeForge vignette in this package for more information.  
一个单一的整数，表示所需数量的口罩，每个序列。在这个包的更多信息，请参见BSgenomeForge暗角。

These arguments are named accordingly to the corresponding fields of a BSgenome data package seed file. See the BSgenomeForge vignette in this package for more information.  
这些参数被命名为相应的BSgenome数据包种子文件的相应字段。在这个包的更多信息，请参见BSgenomeForge暗角。


Details

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

These functions are intended for Bioconductor users who want to make a new BSgenome data package, not for regular users of these packages. See the BSgenomeForge vignette in this package (vignette("BSgenomeForge")) for an extensive coverage of this topic.
Bioconductor用户谁想要使一个新的BSgenome数据包，这些包的普通用户不用于这些功能。请参阅本主题的广泛报道，在这个包BSgenomeForge暗角（vignette("BSgenomeForge")）。


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


H. Pages



举例----------Examples----------


  forgeSeqFiles("chrM", prefix="ce2", suffix=".fa",
                seqs_srcdir=system.file("extdata", package="BSgenome"),
                seqs_destdir=tempdir())
  load(file.path(tempdir(), "chrM.rda"))
  chrM

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


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