主要内容

saminfo

返回关于山姆的信息文件

语法

InfoStruct= saminfo (文件)
InfoStruct = saminfo(文件、名称、值)

描述

InfoStruct= saminfo (文件)返回一个MATLAB®SAM-formatted文件包含摘要的结构信息。

InfoStruct= saminfo (文件,名称,值)返回一个MATLAB结构由一个或多个指定附加选项名称,值对参数。

输入参数

文件

特征向量或字符串指定一个文件名或SAM-formatted文件的路径和文件名。如果你仅指定一个文件名,文件必须在MATLAB搜索路径或在当前文件夹。

名称-值参数

指定可选的双参数作为Name1 = Value1,…,以=家,在那里的名字参数名称和吗价值相应的价值。名称-值参数必须出现在其他参数,但对的顺序无关紧要。

R2021a之前,用逗号来分隔每一个名称和值,并附上的名字在报价。

NumOfReads

逻辑控制的包容NumReadsInfoStruct,输出结构。

请注意

设置NumOfReads真正的可显著提高创建输出结构的时候了。

默认值:

ScanDictionary

逻辑控制的扫描SAM-formatted文件来确定参考名称和读取对齐到每个引用的数量。如果真正的,ScannedDictionaryScannedDictionaryCount字段包含这些信息。

默认值:

输出参数

InfoStruct

MATLAB SAM-formatted文件包含摘要的结构信息。该结构包含这些字段。

描述
文件名 SAM-formatted文件的名称。
FilePath 文件路径。
文件大小 文件的大小,以字节为单位。
FileModDate 文件的修改日期。
NumReads* 顺序读取文件的数量。
ScannedDictionary* 单元阵列特征向量指定参考序列的名称在SAM-formatted文件中。
ScannedDictionaryCount* 单元阵列指定读取每个参考序列对齐的数量。
* * 结构包含文件格式版本,排序顺序和组订单。
SequenceDictionary* *

结构包含:

  • 序列的名字

  • 序列长度

  • 基因组装配标识符

  • 序列的MD5校验和

  • URI的序列

  • 物种

ReadGroup* *

结构包含:

  • 阅读组标识符

  • 样本

  • 图书馆

  • 描述

  • 平台单元

  • 预测中值插入大小

  • 测序中心

  • 日期

  • 平台

程序* *

结构包含:

  • 程序名

  • 版本

  • 命令行

*- - -NumReads如果你不设置字段是空的NumOfReads名称-值对参数真正的。的ScannedDictionaryScannedDictionaryCount如果你不设置字段是空的ScanDictionary名称-值对参数真正的

* *——这些结构和字段出现在输出结构只有在山姆的文件。这些结构中的信息取决于山姆文件中的信息。

例子

返回的信息ex1.sam文件包含在生物信息学工具箱™:

信息= saminfo (“ex1.sam”)
信息=文件名:“丈夫说。山姆的FilePath [1 x89 char):文件大小:254270 FileModDate:“12 - 2011年5月——14:23:25”标题:[1 x1 struct] SequenceDictionary: [1 x1 struct] ReadGroup: [1 x2 struct] NumReads: [] ScannedDictionary: {0 x1细胞}ScannedDictionaryCount: [0 x1 uint64]

返回的信息ex1.sam文件包括序列读取次数:

信息= saminfo(例1。山姆,numofreads,真的)
信息=文件名:“丈夫说。山姆的FilePath [1 x89 char):文件大小:254270 FileModDate:“12 - 2011年5月——14:23:25”标题:[1 x1 struct] SequenceDictionary: [1 x1 struct] ReadGroup: [1 x2 struct] NumReads: 1501 ScannedDictionary: {0 x1细胞}ScannedDictionaryCount: [0 x1 uint64]

提示

使用saminfo调查的规模和内容山姆文件在使用前samread函数将文件内容读入一个MATLAB的结构。

版本历史

介绍了R2010a