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

loveR

readFastq(ShortRead)
readFastq()所属R语言包：ShortRead

                                        Read and write FASTQ-formatted files
                                         读取和写FASTQ格式的文件

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

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

readFastq reads all FASTQ-formated files in a directory dirPath whose file name matches pattern pattern, returning a compact internal representation of the sequences and quality scores in the files. Methods read all files into a single R object; a typical use is to restrict input to a single FASTQ file.
readFastq读取目录dirPath的文件名匹配模式的所有FASTQ的格式化文件pattern，返回一个紧凑的内部文件中的序列和质量分数表示。方法读取所有文件到一个单一的R对象，是一个典型的使用，以限制输入一个单一FASTQ文件。

writeFastq writes an object to a single file, using mode="w" (the default) to create a new file or mode="a" append to an existing file. Attempting to write to an existing file with mode="w" results in an error.
writeFastq写了一个对象，一个单一的file“使用mode="w"（默认），以创建一个新文件或mode="a"追加到现有的文件。试图写入到一个现有的文件mode="w"在一个错误的结果。


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


readFastq(dirPath, pattern=character(0), ...)
## S4 method for signature 'character'
readFastq(dirPath, pattern=character(0), ..., withIds=TRUE)

writeFastq(object, file, mode="w", full=FALSE, ...)



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

参数：dirPath
A character vector (or other object; see methods defined on this generic) giving the directory path (relative or absolute) or single file name of FASTQ files to be read.
一个特征向量（或其他对象;看到这个通用定义的方法）提供的目录路径（相对或绝对）或单一读的FASTQ文件文件名称。


参数：pattern
The (grep-style) pattern describing file names to be read. The default (character(0)) results in (attempted) input of all files in the directory.
（grep式）模式描述被读取的文件名。默认（character(0)）（未遂）输入目录中的所有文件中的结果。


参数：object
An object to be output in fastq format. For methods, use showMethods(object, where=getNamespace("ShortRead")).
对象是fastq格式的输出。对于方法，使用showMethods(object, where=getNamespace("ShortRead"))。


参数：file
A length 1 character vector providing a path to a file to the object is to be written to.
被写入到一个文件对象提供了一个路径一个长度为1的特征向量。


参数：mode
A length 1 character vector equal to either "w" or "a" to write to a new file or append to an existing file, respectively.
一个长度为1的特征向量等于或者W或一写一个新的文件或追加到现有文件，分别为。


参数：full
A logical(1) indicating whether the identifier line should be repeated full=TRUE or omitted full=FALSE on the third line of the fastq record.
逻辑（1）指示标识线是否应重复full=TRUE或遗漏full=FALSE的fastq记录的第三行。


参数：...
Additional arguments. In particular, qualityType and filter:     
额外的参数。尤其是qualityType和filter：

qualityType:Representation to be used for quality scores, must be one of Auto (choose Phred-like if any character is ASCII-encoded as less than 59) FastqQuality (Phred-like encoding), SFastqQuality (Illumina encoding).  
qualityType：要使用质量分数表示，一定要Auto（选择PHRED样，如果任何字符的ASCII编码为小于59）FastqQuality（PHRED般的编码），SFastqQuality（Illumina的编码）。

filter:An object of class srFilter, used to filter objects of class ShortReadQ at input.     
过滤器：一个类的对象srFilter，用于过滤输入对象类ShortReadQ。


参数：withIds
logical(1) indicating whether identifiers should be read from the fastq file.
logical(1)是否说明标识符应从fastq文件的读。


Details

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

The fastq format is not quite precisely defined. The basic definition used here parses the following four lines as a single record:
fastq格式不是很精确的定义。这里使用的基本定义剖析作为一个单独的记录以下四行：


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

readFastq returns a single R object (e.g., ShortReadQ) containing sequences and qualities contained in all files in dirPath matching pattern. There is no guarantee of order in which files are read.
readFastq返回一个单一的R对象（例如，ShortReadQ）含有序列，并在所有文件中包含dirPath匹配pattern素质。有没有为了保证文件是只读的。

writeFastq is invoked primarily for its side effect, creating or appending to file file. The function returns, invisibly, the length of object, and hence the number of records written.
writeFastq被调用，主要用于其副作用，创建或追加到文件file。函数返回时，无形中，object的长度，因此书面记录。


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


Martin Morgan



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

The IUPAC alphabet in Biostrings.
在Biostrings的IUPAC字母。

http://www.bioperl.org/wiki/FASTQ_sequence_format for the BioPerl definition of fastq.
http://www.bioperl.org/wiki/FASTQ_sequence_format为的fastq的bioperl的定义。

Solexa documentation 'Data analysis - documentation : Pipeline output and visualisation'.
公司Solexa文件的数据分析 - 文件：管道输出和可视化“。


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


showMethods(readFastq)
showMethods(writeFastq)

sp <- SolexaPath(system.file('extdata', package='ShortRead'))
rfq <- readFastq(analysisPath(sp), pattern="s_1_sequence.txt")
sread(rfq)
id(rfq)
quality(rfq)

## SolexaPath method 'knows' where FASTQ files are placed[＃SolexaPath法“知道”在FASTQ文件都放在]
rfq1 <- readFastq(sp, pattern="s_1_sequence.txt")
rfq1

file <- tempfile()
writeFastq(rfq, file)
readLines(file, 8)

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


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