Platon 项目使用教程

Platon 项目使用教程

platon Identification & characterization of bacterial plasmid-borne contigs from short-read draft assemblies. 项目地址: https://gitcode.com/gh_mirrors/pl/platon

1. 项目的目录结构及介绍

Platon 项目的目录结构如下：

platon/
├── aux-scripts/
├── bin/
├── db-scripts/
├── platon/
├── test/
├── .gitignore
├── CITATION.bib
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── CONTRIBUTION.md
├── LICENSE
├── README.md
├── environment.yml
├── platon.cwl
├── pytest.ini
└── rds-ratio-counts.web.png

目录介绍

• aux-scripts/: 辅助脚本目录，包含一些用于辅助分析的脚本。
• bin/: 可执行文件目录，包含项目的主要可执行文件。
• db-scripts/: 数据库脚本目录，包含用于处理数据库的脚本。
• platon/: 项目核心代码目录，包含 Platon 的主要功能实现。
• test/: 测试目录，包含项目的测试代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CITATION.bib: BibTeX 格式的引用文件。
• CITATION.cff: Citation File Format 格式的引用文件。
• CODE_OF_CONDUCT.md: 行为准则文件，规定了项目参与者的行为规范。
• CONTRIBUTION.md: 贡献指南文件，指导如何为项目做出贡献。
• LICENSE: 项目许可证文件，规定了项目的开源许可证。
• README.md: 项目说明文件，包含项目的概述、安装和使用说明。
• environment.yml: Conda 环境配置文件，用于配置项目的依赖环境。
• platon.cwl: Common Workflow Language 文件，定义了项目的工作流程。
• pytest.ini: Pytest 配置文件，用于配置测试框架。
• rds-ratio-counts.web.png: 项目相关的图片文件。

2. 项目的启动文件介绍

Platon 项目的启动文件是 platon/platon.py。该文件是项目的主入口，负责启动 Platon 的主要功能。

启动文件介绍

• platon/platon.py: 这是 Platon 项目的主启动文件。它包含了项目的核心逻辑，负责处理输入的基因组数据，进行分析，并输出结果。

3. 项目的配置文件介绍

Platon 项目的配置文件主要包括以下几个：

配置文件介绍

• environment.yml: 该文件用于配置 Conda 环境，定义了项目运行所需的依赖包和版本。
• platon.cwl: 该文件定义了项目的工作流程，使用 Common Workflow Language (CWL) 描述了项目的各个步骤和依赖关系。
• pytest.ini: 该文件用于配置 Pytest 测试框架，定义了测试的配置选项和参数。

配置文件示例

environment.yml

name: platon-env
channels:
  - conda-forge
  - bioconda
  - defaults
dependencies:
  - python=3.8
  - platon
  - prodigal=2.6.3
  - diamond=2.0.6
  - blast=2.10.1
  - mummer=4.0.0-beta2
  - hmmer=3.3.1
  - infernal=1.1.4

platon.cwl

cwlVersion: v1.0
class: CommandLineTool
baseCommand: [platon]
inputs:
  genome:
    type: File
    inputBinding:
      position: 1
  db:
    type: Directory
    inputBinding:
      prefix: --db
  output:
    type: string
    inputBinding:
      prefix: --output
  threads:
    type: int
    inputBinding:
      prefix: --threads
outputs:
  result:
    type: Directory
    outputBinding:
      glob: "*"

pytest.ini

[pytest]
addopts = --cov=platon --cov-report=term-missing
testpaths = test

通过以上配置文件，可以确保 Platon 项目在不同的环境中正常运行，并且能够进行有效的测试和结果输出。

platon Identification & characterization of bacterial plasmid-borne contigs from short-read draft assemblies. 项目地址: https://gitcode.com/gh_mirrors/pl/platon