@gmod/gff-nostream (英语)
解析 GFF3 数据,作为简化版本 @gmod/gff (英语) 没有节点.js流依赖.
安装
pnpm add @gmod/gff-nostream
使用量
import { readFileSync } from 'node:fs'
import { parseStringSync } from '@gmod/gff-nostream'
const features = parseStringSync(readFileSync('my_annotations.gff3', 'utf8'))
在浏览器中,通过任何 GFF3 字符串,例如来自
fetch(…).then(r => r.text())用于远程 .gff3.gz,以
@gmod/tabix (英语) 然后将返回的行传给
parseLines。 。 。 .
对象格式
- 坐标为0相半开.
strand是数字( e)1编号 :-1编号 :0) (中文(简体) ).- 属性变为小写顶级密钥, 当 单值.
- 儿童特征
subfeatures。 。 。 .
{
"refName": "ctg123",
"source": null,
"type": "gene",
"start": 999,
"end": 9000,
"strand": 1,
"subfeatures": [
{
"refName": "ctg123",
"source": null,
"type": "mRNA",
"start": 1049,
"end": 9000,
"strand": 1,
"subfeatures": [],
"id": "mRNA00001",
"parent": "gene00001",
"name": "EDEN.1"
}
],
"id": "gene00001",
"name": "EDEN"
}
解析器附件 2 到一个小写名称与固定名称相匹配的属性
字段 (refName, (中文(简体) ), source, (中文(简体) ), type, (中文(简体) ), start, (中文(简体) ), end, (中文(简体) ), score, (中文(简体) ), strand, (中文(简体) ), phase, (中文(简体) ),
subfeatures, (中文(简体) ), seq_id, (中文(简体) ), refname),这样 Start= 变成 start2。 。 。 .
分析行为
- 解析器忽略了评论,指令,和
##FASTA节. - 解析器裁剪了属性标记周围的空格, 所以
Name=A; ID=x有一个ID。 。 。 . - 一个特征,它的
Parent在输入中缺失, 如 tabix 查询切换 离开母行,回来作为顶级功能.
多地点特性
多位置特性在多行有相同的ID, 如 CDS 横跨多段.
- 没有父母,第一行就变成了一个贯穿每个部分的特征,
将每个部分作为同一类型的子特征。 一个NCBI
cDNA_match来了 这边走. - 与父关系,每行在其下保留一个单独的特征,如同 多出类拔萃 CDS. 解析器仍然合并了另一个行名作为它的 ID 父公司,如已成熟的 NCBI 帧转换 CDS(SARS-CoV-2 ORF1ab) 其下有脓.
- 类型不同或第一行已有子女的行,请留下 单独的重复.
懒惰分析
每个剖面函数都有 …Lazy 将第9栏作为原始文本的对等文本
打开 feature.attributeString 而不是把它传播到键上。 它只读
ID 财务报告和审定财务报表 Parent因为它没有它们就无法建立这棵树.
import { getAttribute, parseLinesLazy } from '@gmod/gff-nostream'
const features = parseLinesLazy(lines)
const names = features.map(f => getAttribute(f, 'name'))
懒惰的解析只有在大多数属性不读时才有回报,因为每个属性
getAttribute 重新扫描字符串。 见
医生/懒惰者。 。 。 .
API 密码
分析
parseStringSync(str: string): GffFeature[]
分析一个 GFF3 字符串 .
parseLines(lines: readonly string[]): GffFeature[]
解析 GFF3 特性行, 如 Tabix 查询返回 。 线条必须包含
无空白、注释或 ##FASTA 节.
parseRecords<R extends LineRecord>(records: readonly R[]): ParsedRecord<R>[]
解析一系列记录来包装原始 GFF3 行 .
解析器配对每个顶级特性及其源记录, 额外字段 包括,所以一个呼叫者可以 附加自己的稳定身份.
const records = lines.map((line, i) => ({ line, offset: offsets[i] }))
const features = parseRecords(records).map(({ feature, record }) => ({
...feature,
id: record.offset,
}))
parseLinesLazy 编号 : parseRecordsLazy
喜欢 parseLines 财务报告和审定财务报表 parseRecords返回时 LazyGffFeatures. 见
懒惰分析。 。 。 .
parseFeatureLazy(line: string): LazyGffFeature
分出一行,无树楼.
属性
getAttribute(feature: LazyGffFeature, key: string): unknown
其解析出的一个属性(小于, 2- 保留后缀)
形状为急切的剖析器生成.
getAttributes(feature: LazyGffFeature): Record<string, unknown>
每一个属性,像渴望的解析器会传播它们.
getLinkAttributes(feature: LazyGffFeature): { id: unknown; parent: unknown }
ID 财务报告和审定财务报表 Parent 在一个通行证, 给打电话的人做自己的联系.
其它
extractType(line: string): string
生线的特征类型(第3栏),或 '' 以小于
两个标签.
hasIdAttribute(line: string): boolean
原始线条是否有 ID 解析器将儿童与
解析器自己的标签扫描.
类型
interface LineRecord {
line: string
}
interface ParsedRecord<R extends LineRecord = LineRecord> {
feature: GffFeature
record: R
}
ParsedLazyRecord 实值 ParsedRecord 带有 LazyGffFeature。 。 。 .
捐款
见 捐款额 为发展和释放步骤.