VGP基因组组装项目教程

VGP基因组组装项目教程

vgp-assembly VGP repository for the genome assembly working group 项目地址: https://gitcode.com/gh_mirrors/vg/vgp-assembly

1. 项目目录结构及介绍

VGP基因组组装项目（vgp-assembly）的目录结构如下：

vgp-assembly/
├── AWS_bucket/
├── dx_applets/
├── dx_scripts/
├── dx_workflows/
├── galaxy_tools/
│   └── parse_mito_blast
├── metadata_documentation/
├── mitoVGP/
├── pipeline/
├── status/
├── tutorials/
├── wdl_pipeline/
├── .gitignore
├── .project
├── .pydevproject
├── DNAnexus_and_AWS_data_structure.md
├── LICENSE
├── README.md
├── VGP_specimen_naming_scheme.md

• AWS_bucket/：包含与AWS S3存储桶相关的文件。
• dx_applets/：存放DNAnexus平台上的独立小应用程序（applets）。
• dx_scripts/：包含DNAnexus平台上使用的脚本。
• dx_workflows/：包含DNAnexus平台上的工作流定义。
• galaxy_tools/：包含Galaxy平台上的工具，例如parse_mito_blast。
• metadata_documentation/：存储与元数据文档相关的文件。
• mitoVGP/：包含用于生成线粒体序列的管道。
• pipeline/：包含用于本地运行的组装管道脚本。
• status/：用于跟踪项目状态的文件。
• tutorials/：存放项目教程和入门资料。
• wdl_pipeline/：包含用于通用的架构和Docker容器的WDL工作流。
• .gitignore：定义Git应该忽略的文件和目录。
• .project和.pydevproject：项目配置文件，与开发环境相关。
• DNAnexus_and_AWS_data_structure.md：描述DNAnexus和AWS数据结构的文档。
• LICENSE：项目的许可证文件。
• README.md：项目的自述文件，介绍了项目的基本信息和如何使用。
• VGP_specimen_naming_scheme.md：描述样本命名方案的文档。

2. 项目的启动文件介绍

项目的启动主要是通过README.md文件中的说明来进行的。该文件提供了项目的概述，包括项目的目标、功能以及如何在不同的平台上使用该项目。通常，项目的启动会涉及到以下步骤：

• 克隆或下载项目到本地环境。
• 根据不同的平台（如Galaxy、DNAnexus或本地环境）选择相应的启动方式。
• 遵循README.md中提供的具体指导，配置必要的环境和依赖。

对于本地运行，可能需要运行pipeline/目录下的脚本，这些脚本的命名通常以_submit_为前缀。

3. 项目的配置文件介绍

项目的配置文件可能包括.project、.pydevproject以及其他在项目目录中指定的配置文件。以下是对一些主要配置文件的简要介绍：

• .gitignore：此文件用于配置Git版本控制系统，指定哪些文件和目录应该被忽略，不应该提交到仓库中。这对于保持仓库的清洁和专注于源代码的管理非常有用。

• DNAnexus_and_AWS_data_structure.md：这个文件描述了数据在DNAnexus和AWS平台上的结构，对于项目数据的存储和管理至关重要。

• 其他特定的配置文件，如metadata_documentation/中的文件，可能用于定义和存储项目元数据的标准和方案。

每个配置文件的具体内容和用途会在其所在的目录或项目的README.md中有详细说明。在开始使用项目之前，应该仔细阅读并按照说明配置这些文件。

vgp-assembly VGP repository for the genome assembly working group 项目地址: https://gitcode.com/gh_mirrors/vg/vgp-assembly