淋病奈瑟菌多重抗原序列分型
ngmaster的Python项目详细描述
[![构建状态](https://travis-ci.org/mdu-phl/ngmaster.svg?branch=master)(https://travis ci.org/mdu-phl/ngmaster)
[![许可证:gplv2](https://img.shields.io/badge/license-gpl_2.0-blue.svg)](https://www.gnu.org/licenses/gpl-2.0)
![Python 3.6](https://img.shields.io/badge/language-python轱3.6-steelblue.svg)
<
````
%ngmaster.py gono.fa
id ng-mast-por-tbpb-br/>gono.fa 10699 6277 4
`````
` `
` ` ` ` `
` ` ` ` ` ` ` ` `
<
*[python>;=3.6](https://www.python.org/)
*[biopython(http://biopython.org/)
<>>>
*[ispcr>;是的= v33x2](http://hgwdev.cse.ucsc.edu/~kent/src/) by Jim Kent
## Installation
### PiPy
```
pip3 install ngmaster
```
### Brew
```
brew install brewsci/bio/ngmaster # COMING SOON
```
### Conda
```
conda install -c bioconda -c conda-forge ngmaster # COMING SOON
```
## test
安装后,您可以运行以下命令以确保"ngmaster"成功工作:
$ngmaster--test
如果一切正常,您将看到以下命令:
````
在测试示例(ng-mast 10699)上运行ngmaster.py……
$ngmaster.py test/test.fa
id ng-mast por tbpb
test.fa 106996277 4
…测试成功。
```
<;fastan>;
Howden BP和Seemann T.
NGMASTER:淋病奈瑟菌多抗原序列分型
Github:https://github.com/mdu-phl/NGMASTER
位置参数:
FastA输入FastA文件,如FastA1、FastA2、FastA3……fastan
可选参数:
-h,--帮助显示此帮助消息并退出
--db db指定包含等位基因数据库的自定义目录
目录必须包含数据库文件"por.tfa","tbpb.tfa",和"ng_mast.txt"
--csv输出逗号分隔格式(csv),而不是制表符分隔格式
--printseq文件指定保存等位基因序列的文件名(默认值为off)
--updatedb update等位基因数据库来自<;www.ng-mast.net>;
--测试运行测试示例
--版本显示程序的版本号并退出
<;fastan>;`
ng-mast结果和等位基因数以制表符分隔格式打印到"stdout"。
*如果找不到等位基因(即无法用引物定位),等位基因结果为"`–`"。
*如果找到等位基因(即用引物定位),但包含序列所需的起始关键基序的保守区域无法定位剪裁,等位基因结果为"无密钥"。
*如果找到等位基因(即用引物定位),但剪裁的序列是新的,而不是在当前数据库中,等位基因结果为"新的"。
**若要将结果保存到制表符分隔的文本文件,请重定向"stdout":**
`$ngmaster<;fasta1>;<;fasta2>;<;快速3>;…<;fastan>;>;results.txt`
**若要以逗号分隔格式显示结果,请使用"--csv"选项:**
`$ngmaster--csv<;fasta1>;<;fasta2>;<;fasta3>;。<;fastan>;`
**将等位基因序列保存到文件中(例如,将"新"序列上载到[http://www.ng-mast.net](http://www.ng-mast.net/)):**
`$ngmaster--printseq[filename]<;fasta1>;<;fasta2>;<;fastA3>;…<;fastan>;`
为了以防万一,会保存旧数据库的,但会被后面的每个``--update db````覆盖。
**将等位基因数据库更新到不同的文件夹(即,不是ngmaster目录中的/db文件夹):**
$ngmaster.py--updatedb--db path/to/folder
将数据库文件下载到文件夹``path/to/folder````.
然后在运行ngmaster时使用```--db path/to/folder``选项指定此选项。
创建自定义数据库文件:`por.tfa`,`tbpb.tfa`,`ng_mast.txt`
有关示例,请参见默认的'db'目录。
"por.tfa"和"tbpb.tfa"包含fasta格式的相应等位基因序列。
`ng_mast.txt`包含ng-mast类型和相应等位基因类型的列表。
2.将自定义数据库文件放在文件夹中。
3.指定自定义数据库文件夹的路径:
`$ngmaster--db[/path/to/custom/folder/]<;fasta1>;<;fasta2>;<;fasta3>;。<;fastan>;`
(https://www.ncbi.nlm.nih.gov/pubmed/28348871)
doi:[10.1099/mgen.0.000076](https://doi.org/10.1099/mgen.0.000076)
\bugs
\software
请通过[github issues page]提交(https://github.com/mdu-phl/ngmaster/issues)。
有关ng-mast数据库的
问题,请联系[ng-mast
馆长](邮箱:d.aanensen@imperial.ac.uk)。
传染病杂志,2004年4月15日;189(8):1497-1505.
*另见[http://www.www.ng-mast-mast.net(http://www.www.ng-mast.net/).
<
递增版本时(即,小补丁),运行以下命令:
```
bumpversion--verbose--dry run--new version<;major.minor.patch>;patch
bumpversion--new version<;new.version.number>;patch
```
y提交并用新版本号标记提交。
它还将更新文件中的必要位置。
[![许可证:gplv2](https://img.shields.io/badge/license-gpl_2.0-blue.svg)](https://www.gnu.org/licenses/gpl-2.0)
![Python 3.6](https://img.shields.io/badge/language-python轱3.6-steelblue.svg)
<
````
%ngmaster.py gono.fa
id ng-mast-por-tbpb-br/>gono.fa 10699 6277 4
`````
` `
` ` ` ` `
` ` ` ` ` ` ` ` `
<
*[python>;=3.6](https://www.python.org/)
*[biopython(http://biopython.org/)
<>>>
*[ispcr>;是的= v33x2](http://hgwdev.cse.ucsc.edu/~kent/src/) by Jim Kent
## Installation
### PiPy
```
pip3 install ngmaster
```
### Brew
```
brew install brewsci/bio/ngmaster # COMING SOON
```
### Conda
```
conda install -c bioconda -c conda-forge ngmaster # COMING SOON
```
## test
安装后,您可以运行以下命令以确保"ngmaster"成功工作:
$ngmaster--test
如果一切正常,您将看到以下命令:
````
在测试示例(ng-mast 10699)上运行ngmaster.py……
$ngmaster.py test/test.fa
id ng-mast por tbpb
test.fa 106996277 4
…测试成功。
```
<;fastan>;
Howden BP和Seemann T.
NGMASTER:淋病奈瑟菌多抗原序列分型
Github:https://github.com/mdu-phl/NGMASTER
位置参数:
FastA输入FastA文件,如FastA1、FastA2、FastA3……fastan
可选参数:
-h,--帮助显示此帮助消息并退出
--db db指定包含等位基因数据库的自定义目录
目录必须包含数据库文件"por.tfa","tbpb.tfa",和"ng_mast.txt"
--csv输出逗号分隔格式(csv),而不是制表符分隔格式
--printseq文件指定保存等位基因序列的文件名(默认值为off)
--updatedb update等位基因数据库来自<;www.ng-mast.net>;
--测试运行测试示例
--版本显示程序的版本号并退出
<;fastan>;`
ng-mast结果和等位基因数以制表符分隔格式打印到"stdout"。
*如果找不到等位基因(即无法用引物定位),等位基因结果为"`–`"。
*如果找到等位基因(即用引物定位),但包含序列所需的起始关键基序的保守区域无法定位剪裁,等位基因结果为"无密钥"。
*如果找到等位基因(即用引物定位),但剪裁的序列是新的,而不是在当前数据库中,等位基因结果为"新的"。
**若要将结果保存到制表符分隔的文本文件,请重定向"stdout":**
`$ngmaster<;fasta1>;<;fasta2>;<;快速3>;…<;fastan>;>;results.txt`
**若要以逗号分隔格式显示结果,请使用"--csv"选项:**
`$ngmaster--csv<;fasta1>;<;fasta2>;<;fasta3>;。<;fastan>;`
**将等位基因序列保存到文件中(例如,将"新"序列上载到[http://www.ng-mast.net](http://www.ng-mast.net/)):**
`$ngmaster--printseq[filename]<;fasta1>;<;fasta2>;<;fastA3>;…<;fastan>;`
为了以防万一,会保存旧数据库的,但会被后面的每个``--update db````覆盖。
**将等位基因数据库更新到不同的文件夹(即,不是ngmaster目录中的/db文件夹):**
$ngmaster.py--updatedb--db path/to/folder
将数据库文件下载到文件夹``path/to/folder````.
然后在运行ngmaster时使用```--db path/to/folder``选项指定此选项。
创建自定义数据库文件:`por.tfa`,`tbpb.tfa`,`ng_mast.txt`
有关示例,请参见默认的'db'目录。
"por.tfa"和"tbpb.tfa"包含fasta格式的相应等位基因序列。
`ng_mast.txt`包含ng-mast类型和相应等位基因类型的列表。
2.将自定义数据库文件放在文件夹中。
3.指定自定义数据库文件夹的路径:
`$ngmaster--db[/path/to/custom/folder/]<;fasta1>;<;fasta2>;<;fasta3>;。<;fastan>;`
(https://www.ncbi.nlm.nih.gov/pubmed/28348871)
doi:[10.1099/mgen.0.000076](https://doi.org/10.1099/mgen.0.000076)
\bugs
\software
请通过[github issues page]提交(https://github.com/mdu-phl/ngmaster/issues)。
有关ng-mast数据库的
问题,请联系[ng-mast
馆长](邮箱:d.aanensen@imperial.ac.uk)。
传染病杂志,2004年4月15日;189(8):1497-1505.
*另见[http://www.www.ng-mast-mast.net(http://www.www.ng-mast.net/).
<
递增版本时(即,小补丁),运行以下命令:
```
bumpversion--verbose--dry run--new version<;major.minor.patch>;patch
bumpversion--new version<;new.version.number>;patch
```
y提交并用新版本号标记提交。
它还将更新文件中的必要位置。