Bio.TogoWS包¶
模块内容¶
提供访问日本DBCLS的TogoWS集成Web服务的代码。
本模块旨在使TogoWS(来自日本DBCLS)更易于使用。请参阅:http://togows.dbcls.jp/
TogoWS睡觉服务提供了对一系列数据库的简单访问,充当了一个代理来保护您免受所有不同的提供者API的影响。这可以使用简单的URL(本模块将为您构建)。有关更多详细信息,请参阅http://togows.dbcls.jp/site/en/rest.html
该功能有点类似于Biopython的Bio.Entrez模块,该模块提供对NCBI的Entrez实用程序(E-Utils)的访问,该实用程序也涵盖了广泛的数据库。
目前,TogoWS没有提供任何使用指南(与NCBI不同,NCBI的要求相当明确)。为了避免服务过载的风险,Biopython将只允许每秒三次调用。
TogoWS soap服务提供了更复杂的API来调用由DDBJ、KEGG和PDBj提供的Web服务(实质上是调用远程函数)。例如,这允许您在DDBJ上运行远程BLAST搜索。本模块还没有介绍这一点,但是TogoWS网站上有很多使用SOAPpy python库的Python示例。请参阅:http://togows.dbcls.jp/site/en/soap.html http://soapy.sourceforge.net/
- Bio.TogoWS.entry(db, id, format=None, field=None)¶
调用TogoWS“entry”以获取记录。
- 参数:
db-database(字符串),请参见下面的列表。
ID-标识符(字符串)或标识符列表(字符串列表或带有逗号分隔符的单个字符串)。
格式-返回数据文件格式(字符串),选项取决于数据库,例如“xml”、“json”、“gff”、“Fasta”、“ttl”(RDF Turtle)
数据库记录(字符串)中的字段特定字段,例如pubmed的“au”或“Authors”。
在撰写本文时,这包括以下内容:
KEGG: compound, drug, enzyme, genes, glycan, orthology, reaction, module, pathway DDBj: ddbj, dad, pdb NCBI: nuccore, nucest, nucgss, nucleotide, protein, gene, onim, homologue, snp, mesh, pubmed EBI: embl, uniprot, uniparc, uniref100, uniref90, uniref50
有关当前名单,请参阅http://togows.dbcls.jp/entry/
此函数实质上等同于NCBI Entrez服务EFetch,在Biopython中以Bio.Entrez.efetch(.)的形式提供,但不提供字段提取。
- Bio.TogoWS.search_count(db, query)¶
调用TogoWS Search Count以查看搜索给出的匹配数。
- 参数:
DB-DATABASE(字符串),请参见http://togows.dbcls.jp/search
查询-搜索词(字符串)
然后可以使用该计数通过Bio.TogoWS.search()的Offset和Limit选项批量下载大量搜索结果。不过,一般来说,Bio.TogoWS.search_iter()函数使用起来更简单。
- Bio.TogoWS.search_iter(db, query, limit=None, batch=100)¶
调用TogoWS search迭代结果(生成器函数)。
- 参数:
DB-DATABASE(字符串),请参见http://togows.dbcls.jp/search
查询-搜索词(字符串)
Limit-可选的搜索结果数量上限
Batch-每次与TogoWS对话时要拉回的搜索结果数(当前限制为100)。
您可以在for循环中使用此函数,例如
>>> from Bio import TogoWS >>> for id in TogoWS.search_iter("pubmed", "diabetes+human", limit=10): ... print("PubMed ID: %s" %id) # maybe fetch data with entry? PubMed ID: ...
在内部,它首先调用Bio.TogoWS.search_count(),然后使用Bio.TogoWS.search()批量获取结果。
- Bio.TogoWS.search(db, query, offset=None, limit=None, format=None)¶
调用TogoWS搜索。
这是TogoWS搜索函数的低级包装器,可以返回多种格式的结果。通常,SEARCH_ITER函数更适合最终用户。
- 参数:
DB-DATABASE(字符串),请参见http://togows.dbcls.jp/search/
查询-搜索词(字符串)
偏移量、限制-可选整数,指定从哪个结果开始(从1开始)和返回的结果数。
格式-返回数据文件格式(字符串),例如“json”,“ttl”(Rdf)默认返回纯文本,每行一个结果。
在撰写本文时,TogoWS应用了100个搜索结果的默认计数限制,这是一个上限。要访问更多结果,请使用OFFSET参数或SEARCH_ITER(.)功能。
TogoWS支持一长串数据库,包括许多来自NCBI(例如“NCBI-pubmed”或“pubmed”、“NCBI-GenBank”或“GenBank”以及“NCBI-taxonomy”)、EBI(例如“ebi-ebml”或“embl”、“ebi-UniProt”或“UniProt”、“ebi-go”)和KEGG(例如“KEGG-Componate”或“Componate”)的数据库
NCBI提供Entrez搜索服务(Esearch),该服务与Biopython中的Bio.Entrez.esearch()函数类似。
另请参阅函数Bio.TogoWS.search_count()和Bio.TogoWS.search_iter()函数,前者返回找到的匹配项数量,后者允许您迭代搜索结果(为您处理批处理)。
- Bio.TogoWS.convert(data, in_format, out_format)¶
调用TogoWS进行文件格式转换。
- 参数:
数据-包含输入记录的字符串或句柄
in_format-描述输入文件格式的字符串(例如“GenBank”)
OUT_FORMAT-描述请求的输出格式的字符串(例如“FASTA”)
有关支持的转换列表(例如,“genbank”到“FASTA”),请参阅http://togows.dbcls.jp/convert/
请注意,Biopython内置了对序列和对齐文件格式转换的支持(函数Bio.SeqIO.Convert和Bio.AlignIO.Convert)