QIIME 2用户文档. 20命令行界面q2cli(2019.7)

前情提要

命令行界面q2cli

QIIME 2 command-line interface (q2cli)

https://docs.qiime2.org/2019.7/interfaces/q2cli/

注:最好按本教程顺序学习,想直接学习本章,至少完成本系列《1简介和安装》

本指南介绍了q2cli,它是QIIME 2 Core发行版中包含的QIIME 2命令行界面。 教程广泛使用q2cli,因此建议在开始教程之前先阅读本文档。 本文档尚在开发中,将来会扩展。

基本用法 Basic usage

q2cli包含一个qiime命令,该命令用于从命令行执行QIIME分析。 运行qiime查看可用子命令的列表:

qiime

将列出几个子命令,包括插件命令(例如feature-table, diversity)和内置命令(例如info, tools)。

您可以通过运行qiime info来发现当前安装了哪些插件以及有关QIIME部署的其他信息:

qiime info`

向任何命令提供--help以显示有关该命令的信息,包括该命令定义的所有子命令,选项和参数。 例如,要了解有关feature-table 插件命令的更多信息,请运行:

qiime feature-table --help

这将列出feature-table插件提供的操作(子命令),以及有关插件本身的信息(例如引文,网站,用户支持)。

尝试使用--help了解其他命令。 例如,内置工具命令中有哪些可用操作?

开启命令行补全Enable command-line tab completion

如果将Bash或Zsh用作Shell,则可以启用制表符补全功能,这将大大提高QIIME 2命令行界面(command-line interface,CLI)的可用性。启用制表符补全功能后,按Tab键将尝试完成您键入的命令或选项,或者根据到目前为止键入的内容为您提供可用命令或选项的列表。这减少了您必须执行的键入操作的数量,并使命令和选项更易于发现,而无需将–help传递给要运行的每个命令。

提示:当前仅在Bash和Zsh Shell中支持QIIME 2 CLI选项补全。要检查您拥有什么Shell,请运行echo $0。您应该在输出中看到-bash-zsh(例如我看到的是/bin/bash)。

请选择适合对说明对应的Shell,方可启用制表符补全。

Bash

运行以下命令以启用制表符完成:

source tab-qiime

每次打开新终端并激活QIIME 2 conda环境时,除非将其添加到您的.bashrc / .bash_profile中,否则都将需要运行此命令。

Zsh

运行以下命令以启用制表符完成:

autoload bashcompinit && bashcompinit && source tab-qiime

除非将其添加到.zshrc中,否则每次打开新终端并激活QIIME 2 conda环境时,都需要运行此命令。

验证标签页完成 Verify tab completion

要测试选项卡补全功能是否正常运行,请尝试键入以下部分命令,而无需实际运行该命令,请按Tab键(您可能需要按几次)。如果制表符补全有效,则命令应自动补齐qiime info

qiime i

Reference

https://docs.qiime2.org/2019.7

Evan Bolyen*, Jai Ram Rideout*, Matthew R. Dillon*, Nicholas A. Bokulich*, Christian C. Abnet, Gabriel A. Al-Ghalith, Harriet Alexander, Eric J. Alm, Manimozhiyan Arumugam, Francesco Asnicar, Yang Bai, Jordan E. Bisanz, Kyle Bittinger, Asker Brejnrod, Colin J. Brislawn, C. Titus Brown, Benjamin J. Callahan, Andrés Mauricio Caraballo-Rodríguez, John Chase, Emily K. Cope, Ricardo Da Silva, Christian Diener, Pieter C. Dorrestein, Gavin M. Douglas, Daniel M. Durall, Claire Duvallet, Christian F. Edwardson, Madeleine Ernst, Mehrbod Estaki, Jennifer Fouquier, Julia M. Gauglitz, Sean M. Gibbons, Deanna L. Gibson, Antonio Gonzalez, Kestrel Gorlick, Jiarong Guo, Benjamin Hillmann, Susan Holmes, Hannes Holste, Curtis Huttenhower, Gavin A. Huttley, Stefan Janssen, Alan K. Jarmusch, Lingjing Jiang, Benjamin D. Kaehler, Kyo Bin Kang, Christopher R. Keefe, Paul Keim, Scott T. Kelley, Dan Knights, Irina Koester, Tomasz Kosciolek, Jorden Kreps, Morgan G. I. Langille, Joslynn Lee, Ruth Ley, Yong-Xin Liu, Erikka Loftfield, Catherine Lozupone, Massoud Maher, Clarisse Marotz, Bryan D. Martin, Daniel McDonald, Lauren J. McIver, Alexey V. Melnik, Jessica L. Metcalf, Sydney C. Morgan, Jamie T. Morton, Ahmad Turan Naimey, Jose A. Navas-Molina, Louis Felix Nothias, Stephanie B. Orchanian, Talima Pearson, Samuel L. Peoples, Daniel Petras, Mary Lai Preuss, Elmar Pruesse, Lasse Buur Rasmussen, Adam Rivers, Michael S. Robeson, Patrick Rosenthal, Nicola Segata, Michael Shaffer, Arron Shiffer, Rashmi Sinha, Se Jin Song, John R. Spear, Austin D. Swafford, Luke R. Thompson, Pedro J. Torres, Pauline Trinh, Anupriya Tripathi, Peter J. Turnbaugh, Sabah Ul-Hasan, Justin J. J. van der Hooft, Fernando Vargas, Yoshiki Vázquez-Baeza, Emily Vogtmann, Max von Hippel, William Walters, Yunhu Wan, Mingxun Wang, Jonathan Warren, Kyle C. Weber, Charles H. D. Williamson, Amy D. Willis, Zhenjiang Zech Xu, Jesse R. Zaneveld, Yilong Zhang, Qiyun Zhu, Rob Knight & J. Gregory Caporaso#. Reproducible, interactive, scalable and extensible microbiome data science using QIIME 2. Nature Biotechnology. 2019, 37: 852-857. doi:10.1038/s41587-019-0209-9

译者简介

刘永鑫,博士。2008年毕业于东北农大微生物学,2014年于中科院遗传发育所获生物信息学博士,2016年博士后出站留所工作,任宏基因组学实验室工程师。目前主要研究方向为宏基因组数据分析和植物微生物组,QIIME 2项目参与人。目前在Science、Nature Biotechnology等杂志发表论文十余篇。2017年7月创办“宏基因组”公众号,目前分享宏基因组、扩增子原创文章400余篇,代表博文有《扩增子图表解读、分析流程和统计绘图三部曲(21篇)》《Nature综述:手把手教你分析菌群数据(1.8万字)》《QIIME2中文教程(18篇)》等,关注人数6.5万+,累计阅读1000万+。

猜你喜欢

写在后面

为鼓励读者交流、快速解决科研困难,我们建立了“宏基因组”专业讨论群,目前己有国内外5000+ 一线科研人员加入。参与讨论,获得专业解答,欢迎分享此文至朋友圈,并扫码加主编好友带你入群,务必备注“姓名-单位-研究方向-职称/年级”。技术问题寻求帮助,首先阅读《如何优雅的提问》学习解决问题思路,仍末解决群内讨论,问题不私聊,帮助同行。

点击阅读原文,跳转最新文章目录阅读

2 Likes