IRIDA StarAMR 结果

IRIDA StarAMR 结果程序使通过 IRIDA 运行的 StarAMR 分析结果能够使用命令行批量下载到电子表格集合中。

安装

Pypi 安装：https ://pypi.org/project/irida-staramr-results/

pip install irida-staramr-results

Conda 安装：https ://anaconda.org/bioconda/irida-staramr-results

conda install -c bioconda irida-staramr-results

如何使用：

• 假设您已经安装了程序，您可以使用irida-staramr-results命令。

  例子

  $ irida-staramr-results --help
  

  $ irida-staramr-results -u admin -pw password1 -c /path/to/conf.yml -p 1 -o out -fd 2021-01-02 -td 2021-04-31
  

• 它接受一些参数：

  论据

  必需的：

  姓名	捷径	类型	例子	描述
  --project	-p	int	1	扫描 StarAMR 结果的项目。
  --config	-c	string	/path/to/conf.yml	配置文件的路径。在此处查看配置详细信息。

  可选的：

  姓名	捷径	类型	例子	描述
  --help	-h	不适用	不适用	显示帮助信息。
  --version	-v	不适用	不适用	当前版本的 irida-staramr-results。
  --split_results	-sr	不适用	不适用	将每个分析结果导出到单独的输出文件中，每次分析生成一个.xlsx文件。
  --username	-u	string	行政	这是您的 IRIDA 帐户用户名。
  --password	-pw	string	密码1	这是您的 IRIDA 帐户密码。
  --output	-o	string	出去	输出 Excel 文件的名称。
  --from_date	-fd	string	2021-01-03	仅下载从该日期创建的分析结果。*
  --to_date	-td	string	2021-04-01	仅下载迄今为止创建的分析结果。*

  笔记：

  • * 日期格式为YYYY-mm-dd（例如 2021-04-08），包括输入日期的 00:00:00 到 23:59:59 之间的时间。

设置

Python

IRIDA StarAMR 结果需要Python 3.8 或更高版本。检查您使用的 Python 版本：

$ python --version

IRIDA REST API 的配置

• 您将需要在 IRIDA 中有一个客户端实例。

  • 只有 IRIDA 管理员可以创建客户端实例。用户应联系其 IRIDA 管理员以获取客户端凭据。
  • 有关详细信息，请参阅IRIDA 客户端配置指南。

• 您需要在 YAML 中创建自己的配置文件。这是一个例子。

  领域：

  • base-url：从中下载结果的服务器 URL。如果您在 Web 浏览器中导航到您的 IRIDA 实例，则 URL（在您登录后）通常如下所示：https ://irida.corefacility.ca/irida/ 。您应该在“服务器 URL”字段中输入的 URL 是那个 URL，最后带有 api/。所以在https://irida.corefacility.ca/irida/的情况下，你应该输入 URL https://irida.corefacility.ca/irida/api/
  • client-id：您创建的 IRIDA 客户端的 id
  • client-secret：您创建的 IRIDA 客户端的 id

从源代码安装

以下说明描述了如何从存储库安装和执行 IRIDA StarAMR 结果。

1. 克隆存储库：

   $ git clone https://github.com/phac-nml/irida-staramr-results.git
   

2. 安装和构建项目

   $ cd irida-staramr-results
   $ make
   $ source .virtualenv/bin/activate
   

3. 执行程序：请参阅上面的参数表了解这些参数的含义。

   $ irida-staramr-results -u <IRIDA_USERNAME> -pw <IRIDA_PASSWORD> -c <CONFIG_FILE_PATH> -p <PROJECT> -o <OUTPUT_FILE_NAME> -fd <FROM_DATE> -td <TO_DATE>
   

运行测试

单元测试

1. 可以使用以下命令运行单元测试：

   $ make unittests
   

开发人员说明

要显示调试消息，请将日志记录级别从 更改logging.INFO为logging.DEBUGin cli.py。这将禁用进度条并显示所请求内容的 ID。

合法的

加拿大政府版权 2021

作者：加拿大公共卫生署国家微生物实验室

根据 Apache 许可证 2.0 版（“许可证”）获得许可；除非遵守许可，否则您不得使用本作品。您可以在以下位置获取许可证副本：

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则根据许可分发的软件将按“原样”分发，没有任何明示或暗示的保证或条件。有关许可下的特定语言管理权限和限制，请参阅许可。

接触

加里·范多姆塞拉：gary.vandomselaar@phac-aspc.gc.ca