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

loveR

transcriptsBy(GenomicFeatures)
transcriptsBy()所属R语言包：GenomicFeatures

                                         Extract and group genomic features of a given type
                                         一个给定类型的提取和组基因功能

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

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

Generic functions to extract genomic features of a given type grouped based on another type of genomic feature. This page documents the methods for TranscriptDb objects only.
通用函数来提取一个给定类型分组的基础上另一种类型的基因特征的基因组功能。这个页文件只TranscriptDb对象的方法。


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


transcriptsBy(x, by=c("gene", "exon", "cds"), ...)
## S4 method for signature 'TranscriptDb'
transcriptsBy(x, by=c("gene", "exon", "cds"), use.names=FALSE)

exonsBy(x, by=c("tx", "gene"), ...)
## S4 method for signature 'TranscriptDb'
exonsBy(x, by=c("tx", "gene"), use.names=FALSE)

cdsBy(x, by=c("tx", "gene"), ...)
## S4 method for signature 'TranscriptDb'
cdsBy(x, by=c("tx", "gene"), use.names=FALSE)

intronsByTranscript(x, ...)
## S4 method for signature 'TranscriptDb'
intronsByTranscript(x, use.names=FALSE)

fiveUTRsByTranscript(x, ...)
## S4 method for signature 'TranscriptDb'
fiveUTRsByTranscript(x, use.names=FALSE)

threeUTRsByTranscript(x, ...)
## S4 method for signature 'TranscriptDb'
threeUTRsByTranscript(x, use.names=FALSE)



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

参数：x
A TranscriptDb object.
TranscriptDb对象。


参数：...
Arguments to be passed to or from methods.
参数被传递到或从方法。


参数：by
One of "gene", "exon", "cds" or "tx". Determines the grouping.
一个"gene"，"exon"，"cds"或"tx"。确定分组。


参数：use.names
Controls how to set the names of the returned GRangesList object. These functions return all the features of a given type (e.g. all the exons) grouped by another feature type (e.g. grouped by transcript) in a GRangesList object. By default (i.e. if use.names is FALSE), the names of this GRangesList object (aka the group names) are the internal ids of the features used for grouping (aka the grouping features), which are guaranteed to be unique. If use.names is TRUE, then the names of the grouping features are used instead of their internal ids. For example, when grouping by transcript (by="tx"), the default group names are the transcript internal ids ("tx_id"). But, if use.names=TRUE, the group names are the transcript names ("tx_name"). Note that, unlike the feature ids, the feature names are not guaranteed to be unique or even defined (they could be all NAs). A warning is issued when this happens. See ?id2name for more information about feature internal ids and feature external names and how to map the formers to the latters.  Finally, use.names=TRUE cannot be used when grouping by gene by="gene". This is because, unlike for the other features, the gene ids are external ids (e.g. Entrez Gene or Ensembl ids) so the db doesn't have a "gene_name" column for storing alternate gene names.  
控制如何设置的返回GRangesList对象的名称。这些函数返回给定类型的另一个特征类型在GRangesList对象（如成绩单分组）进行分组（例如，所有的外显子）的所有功能。默认情况下（即如果use.names是FALSE），这GRangesList对象（又名组名）的名称是用于分组（又名分组功能）功能的内部ID，这是保证是唯一的。 use.names如果是TRUE，然后分组功能的名称使用，而不是他们的内部ID。例如，当分组全文（by="tx"），默认组名称谈话内部ID（"tx_id"）。但是，如果use.names=TRUE，组名的成绩单名称（"tx_name"）。请注意，不同的功能IDS的功能名称，但不保证是唯一的，甚至定义（他们可能是所有NAS）。发生这种情况时，将发出警告。看到?id2name有关内部ID功能和功能的外部名称，以及如何映射前者向后者的信息。最后，use.names=TRUE不能被分组时使用基因by="gene"。这是因为，不像其他功能，基因标识的外部IDS（如Entrez基因或Ensembl的IDS），所以DB没有储存备用基因名称"gene_name"列。


Details

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

These functions return a GRangesList object where the ranges within each of the elements are ordered according to the following rule:
这些函数返回一个对象，根据以下规则范围内的每个元素是有序的GRangesList：

When using exonsBy and cdsBy with by = "tx", the ranges are returned in the order they appear in the transcript, i.e. order by the splicing.exon_rank field in x's internal database. In all other cases, the ranges will be ordered by chromosome, strand, start, and end values.
当使用exonsBy和cdsBy by = "tx"用，返回他们在谈话中出现的顺序，即由splicing.exon_rank场秩序x的内部范围数据库。在所有其他情况下，该范围将被责令染色体，钢绞线，开始和结束值。


值----------Value----------

A GRangesList object.
GRangesList对象。


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



M. Carlson, P. Aboyoun and H. Pages




参见----------See Also----------

TranscriptDb, transcripts, id2name, transcriptsByOverlaps
TranscriptDb，transcripts，id2name，transcriptsByOverlaps


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


  txdb_file <- system.file("extdata", "UCSC_knownGene_sample.sqlite",
                           package="GenomicFeatures")
  txdb <- loadFeatures(txdb_file)

  ## Get the transcripts grouped by gene:[＃获取基因组的成绩单：]
  transcriptsBy(txdb, "gene")

  ## Get the exons grouped by gene:[＃获取基因组外显子的：]
  exonsBy(txdb, "gene")

  ## Get the cds grouped by transcript:[＃获取由成绩单分组的光盘：]
  cds_by_tx0 <- cdsBy(txdb, "tx")
  ## With more informative group names:[＃更多的信息组名：]
  cds_by_tx1 <- cdsBy(txdb, "tx", use.names=TRUE)
  ## Note that 'cds_by_tx1' can also be obtained with:[＃注意，“cds_by_tx1也可以得到：]
  names(cds_by_tx0) <- id2name(txdb, feature.type="tx")[names(cds_by_tx0)]
  stopifnot(identical(cds_by_tx0, cds_by_tx1))

  ## Get the introns grouped by transcript:[＃获取由成绩单分组的内含子：]
  intronsByTranscript(txdb)

  ## Get the 5' UTRs grouped by transcript:[＃获取成绩单分组的5非编码区：]
  fiveUTRsByTranscript(txdb)
  fiveUTRsByTranscript(txdb, use.names=TRUE)  # more informative group names[更多的信息组名]

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


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