蠕虫Rest API包装器
wormstools的Python项目详细描述
虫子工具
特点:
- [x] 从WoRMS database获取最新信息
- [x] 基于终端的脚本
软件要求:
- Python3
安装
通过使用pip
:
pipinstallwormstools
使用git
(可选):
蚜虫
我们可以获得蠕虫数据库识别特定物种(即蚜虫)的物种ID。如果这个ID未知,则无法验证物种或继续进行下游程序。因此,了解蚜虫种类是在蠕虫数据库中获取元数据的重要步骤。在
假设我们在species.txt存储了以下物种列表:
cat species.txt
Conus roosevelti
Latirus hemphilli
Favartia peasei
Lolliguncula panameusis
Pholoides tuberculata
我们可以通过以下方法获得蚜虫:
worms species.txt -id
默认情况下,worms
使用其输入来命名所有输出,但是可以使用--out
选项对其进行修改。由于未指定任何输出名称,因此默认情况下,输出名称为species_worms_aphiaID.tsv
,并且包含以下内容:
species aphiaIDs Obs Conus roosevelti 429945 Latirus hemphilli 447141 Favartia peasei 738152 Lolliguncula panameusis Record not found in WoRMS Pholoides tuberculata Record not found in WoRMS
验证名称
可以使用选项-val
获得当前根据蠕虫对每种物种的接受名称。使用此选项时,输出包含以下列:species,validated names和obs。如果存在无法通过蠕虫验证的物种,则在obs列中声明。在
示例:
worms species.txt -val
默认情况下,输出名称为species_worms_val.tsv
,包含以下内容:
species validated names Obs
Conus roosevelti Conus tiaratus
Latirus hemphilli Pustulatirus hemphilli
Favartia peasei Favartia peasei
Lolliguncula panameusis Lolliguncula (Lolliguncula) panamensis
Pholoides tuberculata Record not found in WoRMS
同义词
使用选项-syn
可以获得每个物种的同义词。这个选项是依赖于蚜虫的,这意味着它获得同义词,如果每个给定的物种有任何可用的蚜虫,包括不被接受的物种。使用此选项时,输出包含以下列:species,同义词和obs。如果有一个在蠕虫中找不到的物种,它的有效名称将被取出来并在obs列中声明。此外,如果这一物种不能被证实,它也会在obs列中说明。在
示例:
worms species.txt -syn
默认情况下,输出名称为species_worms_syn.tsv
,包含以下内容:
species synonyms Obs
Conus roosevelti
Latirus hemphilli
Favartia peasei Murex foveolatus, Murex peasei
Lolliguncula (Lolliguncula) panamensis Lolliguncula panamensis, Lolliguncula tydeus Deprecated name: Lolliguncula panameusis
Pholoides tuberculata Record not found in WoRMS
*虽然没有蚜虫的物种可以通过验证来获得蚜虫,也可以简单地跳过,但是引入一个已验证物种的列表是非常值得推荐的(参见如何here)。
分类等级
使用选项--at
可以获得不同的分类类别。这个选项是依赖于蚜虫的,这意味着如果每个给定的物种都有任何蚜虫,包括不被接受的种类,它就获得分类类别。使用此选项时,输出会根据--at
选项中引入的值而变化(请参见示例)。然而,列名的结构是这样的:[Taxa]+^{str1}$species+^{str1}$obs。如果有一个在蠕虫中找不到的物种,它的有效名称将被取出来并在obs列中声明。此外,如果这一物种不能被证实,它也会在obs列中说明。在
示例:
worms species.txt --at Class Family
默认情况下,输出名称为species_worms_ranks.tsv
,包含以下内容:
Class Family Species Obs
Gastropoda Conidae Conus roosevelti
Gastropoda Fasciolariidae Latirus hemphilli
Gastropoda Muricidae Favartia peasei
Cephalopoda Loliginidae Lolliguncula (Lolliguncula) panamensis deprecated name: Lolliguncula panameusis
Pholoides tuberculata Record not found in WoRMS
最后,此选项可与上述所有选项一起使用。在
*虽然没有蚜虫的物种可以通过验证来获得蚜虫,也可以简单地跳过,但是引入一个已验证物种的列表是非常值得推荐的(参见如何here)。
在python3
python3内部使用WoRMStools
的方式与我们已经看到的终端中的用法非常相似:
# import worms classfromwormstools.core_wormsimportWorms# get aphiaIDWorms(taxon='Conus roosevelti').aphiaID# validate nameWorms(taxon='Conus roosevelti').taxamatch()# get synonymsWorms(taxon='Favartia peasei').get_synonyms()# get an specific taxonomic rankWorms(taxon='Favartia peasei').get_rank(rank='Family')
- 项目
标签: