主要内容

bowtie2inspect

检查Bowtie 2索引文件

描述

例子

bowtie2inspect (indexBaseNameoutputFileName检查带有前缀的Bowtie2索引文件indexBaseName,检查用于构建索引的原始引用序列,并将引用序列保存在输出文件中outputFileName

bowtie2inspect要求用于领结对准器的生物信息学工具箱™接口.如果没有安装此支金宝app持包,则该函数提供下载链接.有关详细信息,请参见生物信息学工具箱软件支持包金宝app

请注意

bowtie2inspect支持金宝appMac和UNIX®平台。

例子

bowtie2inspect (___inspectOptions使用指定的附加选项inspectOptions.在所有其他输入参数之后指定选项。

例子

国旗= bowtie2inspect (___返回一个退出国旗使用前面语法中的任何输入参数的函数。

例子

全部折叠

使用。获取有关用于构建相应索引文件的引用序列的信息bowtie2inspect.如果在运行该函数时没有安装用于领结对准器的生物信息学工具箱接口支持包,则会出现错误消息。金宝app单击提供的链接从Add-on菜单下载包。

bowtie2inspect (“Dmel_chr4”“Dmel_chr4_retrieved.fa”);

默认情况下,输出文件Dmel_chr4_retrieved.fa包含用于构建索引的引用的实际序列。

您还可以获得关于引用名称和长度的摘要信息,而不是实际序列。

创建一个选项对象。

inspectOpt = Bowtie2InspectOptions;

设置总结财产真正的

inspectOpt。总结= true;

使用指定的选项再次运行函数。

国旗= bowtie2inspect (“Dmel_chr4”“Dmel_chr4_summary.fa”, inspectOpt);

如果索引检查成功,则函数返回0,输出文件现在包含引用序列的摘要信息。

或者,您可以传入一个Bowtie 2语法字符串,而不是使用option对象。

国旗= bowtie2inspect (“Dmel_chr4”“Dmel_chr4_summary2.fa”“s”);

输入参数

全部折叠

引用索引文件的基名(前缀),指定为字符向量或字符串。索引文件在BT2BT21格式。

例子:“Dmel_chr4”

数据类型:字符|字符串

输出文件的名称,指定为字符串或字符向量。默认情况下,输出文件包含用于构建索引文件的引用序列。

例子:“refSeq.fa”

数据类型:字符|字符串

用于检查索引文件的选项,索引文件被指定为字符向量、字符串或Bowtie2InspectOptions对象。字符向量或字符串必须符合Bowtie 2选项语法(以一或两个破折号作为前缀)[1]

对于一个Bowtie2InspectOptions对象时,只有修改后的属性才用于运行该函数。

例子:'——trim5 10 -s 5'

输出参数

全部折叠

函数的退出状态,返回一个整数。国旗0如果函数运行时没有错误或警告。否则,它是非零的。

参考文献

Langmead, B.和S. Salzberg。“快速间隙读取与领结2对齐。”自然方法.9日,2012年,357 - 359。

介绍了R2018a