빠른 시작

1. 빠른 시작#

1.1. metaFun 설치 및 실행#

1.1.1. 1. biocontainer 설치#

시스템에 conda나 mamba가 설치되어 있지 않다면, 안내에 따라 conda나 mamba를 설치하세요. miniconda 또는 mamba를 설치하는 것을 권장합니다.

miniconda 설치#
# Linux OS를 사용한다고 가정합니다.
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
# -p $PATH를 대체하여 설치 경로를 지정할 수 있습니다. $PATH는 conda 설치의 기본 디렉토리입니다.
bash miniconda.sh -b -u -p ~/miniconda3
rm  miniconda.sh

mamba 설치

빠른 설치를 위해 miniforge github의 지침에 따라 적합한 mamba를 설치하는 것을 권장합니다.

1.1.2. 2. Bioconda에서 metaFun 다운로드#

# metaFun을 위한 새로운 conda 환경 생성을 권장합니다
conda create -n metafun bioconda::metafun
# mamba가 있다면, mamba로 metaFun을 설치할 수 있습니다
mamba create -n metafun bioconda::metafun

mamba activate metafun

1.1.3. 3. metaFun 활용을 위한 데이터베이스 다운로드#

# 데이터베이스 다운로드
conda activate metafun
 (metafun) name $ metafun  -module DOWNLOAD_DB

module DOWNLOAD_DB 실행

metafun -module DOWNLOAD_DB 실행은 다음 그림과 같습니다.

metafun_pipeline

module DOWNLOAD_DB 실행

데이터베이스의 크기가 매우 크기 때문에(원시 tar gzip 파일 크기: ~683GB), 네트워크 속도에 따라 다운로드하는 데 시간이 걸릴 수 있습니다. 데이터베이스 정보는 다운로드 저장소에서 확인할 수 있습니다.

다운로드된 데이터베이스의 무결성은 sha256을 비교하여 자동으로 확인됩니다. 문제가 있다면 데이터베이스를 다시 다운로드해 주세요.

일반적으로 다음 명령어로 데이터베이스 경로를 찾을 수 있습니다.

ls -d $(find $(dirname $(which metafun)) -type d ! -name 'metafun')/../share/metafun/db

1.1.4. 4. metaFun의 모듈 실행#

metaFun은 두 가지 주요 분석 워크플로우를 제공합니다:

1.1.4.1. 게놈 기반 분석 경로:#

RAWREAD_QC → ASSEMBLY_BINNING → BIN_ASSESSMENT → GENOME_SELECTOR → COMPARATIVE_ANNOTATION → INTERACTIVE_COMPARATIVE

1.1.4.2. 리드 기반 분석 경로:#

분류학적 구성을 위한 경로

RAWREAD_QC → WMS_TAXONOMY → INTERACTIVE_TAXONOMY

기능 주석을 위한 경로

RAWREAD_QC → WMS_FUNCTION

균주 수준 분석을 위한 경로

RAWREAD_QC → WMS_TAXONOMY → WMS_STRAIN → INTERACTIVE_STRAIN

네트워크 분석을 위한 경로

WMS_TAXONOMY → INTERACTIVE_NETWORK

다음 구문을 사용하여 metaFun의 각 모듈을 실행할 수 있습니다:

metafun -module <module_name> [options]

1.1.4.3. 사용 가능한 모듈#

중요 워크플로우 정보

  • RAWREAD_QC에 대한 입력 디렉토리를 지정할 때, 명시적으로 재정의하지 않는 한 후속 모듈은 자동으로 이전 단계의 출력을 입력으로 사용합니다.

  • 필수 매개변수는 일반적으로 메타데이터 파일과 해당 열(샘플 ID 또는 분석 열)을 지정할 때 필요합니다. 메타데이터가 필요한 각 모듈은 이러한 매개변수를 명시적으로 정의해야 합니다.

  • 가장 효율적인 사용을 위해 위에 표시된 색상 코드가 지정된 워크플로우 경로를 따르세요.

1.2. RAWREAD_QC: 원시 리드의 품질 제어 및 숙주 게놈 필터링#

필수: -i (입력 리드 디렉토리)

예시#
metafun -module RAWREAD_QC -i input_reads/

1.3. ASSEMBLY_BINNING: 어셈블리 및 빈닝#

선택 사항: -i (필터링된 리드 디렉토리) (출력 매개변수 없이 RAWREAD_QC를 실행한 경우, 이 모듈에서 -i 매개변수 없이 실행할 수 있습니다.)

예시#
metafun -module ASSEMBLY_BINNING -i filtered_reads/ -p 40

1.4. BIN_ASSESSMENT: 게놈 품질 평가 및 분류학적 분류#

필수: -m -c <accession_column>

예시#
metafun -module BIN_ASSESSMENT -m metadata.txt -c 2

1.5. GENOME_SELECTOR: 게놈 선택 인터페이스#

필수: -i <input_file>

예시#
metafun -module GENOME_SELECTOR -i combined_metadata.csv

1.6. COMPARATIVE_ANNOTATION: 비교 게놈 분석#

필수: -i -m

예시 (INTERACTIVE_COMPARATIVE 모듈을 위한 주석만)#
metafun -module COMPARATIVE_ANNOTATION  --metadata metadata.csv --samplecol 1
예시 (정적 그래프 포함) 이 방법은 더 이상 사용되지 않습니다.#
metafun -module COMPARATIVE_ANNOTATION -i genomes/ -m metadata.csv --samplecol 1 --metacol 2

1.7. INTERACTIVE_COMPARATIVE: 대화형 비교 분석#

필수: -i -m

예시#
metafun -module INTERACTIVE_COMPARATIVE -i results/genomes -m metadata.csv

1.8. WMS_TAXONOMY: 메타게놈 리드의 분류학적 프로파일링#

필수: -m -s

기본 선택은 sylph입니다.

kraken2를 사용하려면 kraken2 데이터베이스를 다운로드하고 --profiler kraken2를 지정하세요.

-s 옵션은 메타게놈 데이터의 쌍을 이루는 리드 파일의 접근 열 접두사입니다.

-i 옵션은 메타게놈 데이터의 입력 디렉토리입니다. RAWREAD_QC 모듈을 실행하지 않았다면 이 옵션을 지정해야 합니다.

예시#
metafun -module WMS_TAXONOMY  -m meta.csv -s 1

1.9. INTERACTIVE_TAXONOMY: 대화형 분류학 분석#

필수: -i

예시#
metafun -module INTERACTIVE_TAXONOMY -i results/metagenome/WMS_TAXONOMY

1.10. WMS_FUNCTION: 메타게놈 리드의 기능 분석#

필수: -i -m -s -a

예시#
metafun -module WMS_FUNCTION -i filtered_reads/ -m metadata.csv -s 1 -a 2

1.11. WMS_STRAIN: 균주 수준 미세다양성 분석#

필수: -i –phyloseq_object <phyloseq_RDS>

WMS_TAXONOMY 출력 필요

이 모듈은 균주 수준에서 분석할 우세 분류군을 선택하기 위해 WMS_TAXONOMY의 phyloseq RDS 객체가 필요합니다.

예시#
metafun -module WMS_STRAIN -i results/metagenome/RAWREAD_QC/read_filtered \
    --phyloseq_object results/metagenome/WMS_TAXONOMY/phyloseq/phyloseq_object_sylph.RDS

1.12. INTERACTIVE_STRAIN: 대화형 균주 다양성 분석#

필수: -i

예시#
metafun -module INTERACTIVE_STRAIN -i results/metagenome/WMS_STRAIN

1.13. INTERACTIVE_NETWORK: 대화형 미생물 네트워크 분석#

필수: -i <phyloseq_RDS>

WMS_TAXONOMY 출력 필요

이 모듈은 공존 네트워크 구축을 위해 WMS_TAXONOMY의 phyloseq RDS 객체가 필요합니다.

예시#
metafun -module INTERACTIVE_NETWORK -i results/metagenome/WMS_TAXONOMY/phyloseq/phyloseq_object_sylph.RDS

1.14. DOWNLOAD_DB: 필요한 데이터베이스 다운로드#

예시#
metafun -module DOWNLOAD_DB

1.15. PREPARE_CUSTOM_HOST: 사용자 정의 숙주 게놈 인덱스 준비#

필수: -i -f

예시#
metafun -module PREPARE_CUSTOM_HOST -i genome.fasta -f mouse

모든 사용자 정의 숙주 게놈을 사용할 수 있습니다.

사용자 정의 숙주 게놈을 사용하려면 fasta 파일의 경로와 -f로 숙주 게놈의 이름을 지정하세요.

사용자 정의 숙주 게놈을 필터링하기 위해 RAWREAD_QC 모듈에서 -f 옵션을 지정해야 합니다.

1.16. 공통 옵션#

  • -o, --output: 출력 디렉토리

  • -p, --processors: 사용할 프로세서 수

  • -h, --help: 모듈에 대한 자세한 도움말 표시

각 모듈의 자세한 사용법 및 추가 매개변수는 다음을 사용하세요:

metafun -module <module_name> -h
Contents