uropa是一个基于命令行的工具,用于基因组区域注释。
uropa的Python项目详细描述
通用健壮峰值注释器
universal robust peak annotator(uropa)是一个基于命令行的工具,用于基因组区域。 注解。基于配置文件,可以使用多个集成查询对不同的目标功能进行优先级排序。 它们对特征类型、距离、链特异性、特征属性(如蛋白质编码)或相对于特征的锚定位置敏感。 uropa可以合并来自不同来源的引用注释文件(gtf),如gencode、ensembl或refseq, 以及用户生成的自定义引用文件。
功能
用允许的灵活参数键检测最合适的注释 健壮性和简单的定制,如
- 功能类型
- 功能定位
- 相对于峰值位置的特征方向
- 过滤属性值,例如“蛋白质编码”
- 链特异性
将所有可用的gtf文件用作注释数据库
一次通过多个查询运行一组可变参数
优先化导致的分级注释
不同的易于阅读的输出表(allhits、finalfits、besthits)。
注释评估的可视化摘要
准备自定义注释文件
文档
有关如何将uropa应用于数据的详细说明,请参见here。
安装和命令行用法
Conda包管理器
我们建议使用conda包管理器安装uropa。确保已安装conda
,例如通过
- Miniconda
- 下载python 3的miniconda安装程序
- 运行
bash Miniconda3-latest-Linux-x86_64.sh
安装miniconda- 回答问题“是否希望安装程序将miniconda安装位置预先设置为/home/../bashrc中的路径?”是的 或者在安装过程之后
PATH=dir/to/miniconda3:$PATH
- 运行
- 下载python 3的miniconda安装程序
uropa安装现在非常简单conda create --name uropa
conda activate uropa
conda install python uropa -c bioconda
生物容器/码头工人
如果您有一个运行的Docker环境,您可以通过
docker pull quay.io/biocontainers/uropa:latest_tag
使用来自taglist的最新标记,例如1.2.1--py27r3.3.2_0
docker pull loosolab/uropa
从源安装
您还可以从源pypi包安装uropa。注意,这没有辅助脚本的R依赖关系:
pip install uropa
要完成所有其他依赖项,请按照以下说明进行操作:
- R/Rscript(v3.3.0或更高版本;按照url上的说明操作)
- 逐步安装所需的软件包:
install.packages(c("ggplot2", "devtools", "gplots", "gridExtra", "jsonlite", "VennDiagram", "getopt", "tidyr", "UpSetR")) source("https://bioconductor.org/biocLite.R") biocLite(c("RBGL", "graph"))
为了用uropa_summary.r绘制chow ruskey plot,请从我们的fork:
library(devtools)
install_github("jenzopr/Vennerable")
使用量
要有效地使用uropa,请熟悉命令行选项:
命令行用法
$ uropa Usage: uropa [options] optional arguments: -h, --help show this help message and exit Arguments for one query: -b , --bed Filename of .bed-file to annotate -g , --gtf Filename of .gtf-file with features --feature [[ ...]] Feature for annotation --feature_anchor [[ ...]] Feature anchor to annotate to --distance [[ ...]] Maximum permitted distance from feature (1 or 2 arguments) --strand [[ ...]] Desired strand of annotated feature relative to peak --relative_location [[ ...]] Peak locaion relative to feature location --internals Set minimum overlap fraction for internal feature annotations. 0 equates to internals=False and 1 equates to internals=True. Default is False. --filter_attribute Filter on 9th column of GTF --attribute_values [[ ...]] Value(s) of attribute corresponding to --filter_attribute --show_attributes [[ ...]] A list of attributes to show in output Multi-query configuration file: -i config.json, --input config.json Filename of configuration file (keys in this file overwrite command-line arguments about query) Additional arguments: -p , --prefix Prefix for result file names (defaults to basename of .bed-file) -o , --outdir Output directory for output files (default: current dir) -s, --summary Filename of additional visualisation of results in graphical format -t n, --threads n Multiprocessed run: n= number of threads to run annotation process -l uropa.log, --log uropa.log Log file name for messages and warnings (default: log is written to stdout) -d, --debug Print verbose messages (for debugging) -v, --version Prints the version and exits
生物容器的使用
从Docker容器运行uropa可以使用以下命令:
sudo docker run --rm -v <path-to-input-files-on-HOST>:<path-to-container-mnt> UROPA:LATEST uropa <UROPA-Paramters> -p <path-to-container-mnt>/'your-file-prefix'
-v参数将主机文件夹装入Docker容器。这个文件夹应该包含uropa的输入文件,结果文件也将存储在这里。容器中不会存储任何文件!
--rm在运行之后删除/关闭容器
确保使用uropa-p选项指定输出目录和前缀,否则结果将在容器环境中丢失。
如何引用
Kondili M、Fust A、Preussner J、Kuenne C、Braun T和Looso M。Uropa:通用健壮峰值注释工具。科学报告7(2017),doi:10.1038/s41598-017-02464-y
贡献
支架
如果您有任何问题,请随时联系Mario Looso(mario.looso@mpi-bn.mpg.de)。
许可证
这个项目是根据麻省理工学院的许可证授权的。