omnition
v1.1.0
Omnition ist eine Pipeline zur Verarbeitung von Daten, die mit dem ddSEQ™ Single-Cell 3' RNA-Seq Kit oder dem ddSEQ™ SureCell ATAC-Seq Library Prep Kit von Bio-Rad und dem dsciATAC-Protokoll generiert wurden. Es führt Debarcoding, Ausrichtung, Perlenzusammenführung, Zellaufruf und Merkmalszählung durch. Die Ausgabe erfolgt in einem HTML-Bericht und Dateien für die nachgelagerte biologische Analyse.
Diese Seite soll als Schnellstart dienen. Die vollständigen Omnition-Benutzerhandbücher finden Sie unter:
Omnition Einzelzell-3'-RNA-Seq
Omnition Single-Cell ATAC-Seq
Einführung in Omnition
Installation
Systemanforderungen
Hardwareanforderungen
Softwareanforderungen
Laden Sie Omnition herunter
Überprüfen Sie die Installation
Erste Schritte
YAML-Konfiguration
Führen Sie die ATAC-Pipeline aus
Führen Sie die RNA-Pipeline aus
Menschliches Genom
Mausgenom
Referenzen
Omnition ausführen
Ausgänge
Omnition Analysis Software nutzt das Nextflow-Framework, um einzelne Prozesse zu verbinden, und führt die Prozesse in virtuellen Umgebungen, sogenannten Containern, mithilfe der Containerprogramme Docker oder Singularity aus. Sobald Omnition auf einem System installiert ist, das die Mindestanforderungen erfüllt, bereitet die Nextflow-Integration mit GitHub und Docker Workflows ohne zusätzliche Konfiguration vor.
Omnition ist für die Ausführung auf einem lokalen Linux-Server, einem HPC-Cluster (High Performance Computing) oder einer virtuellen Cloud-Maschine konzipiert und wurde auf 64-Bit-CentOS 7 und 8, Amazon Linux 2 und Ubuntu 18.04.6, 20.04 LTS getestet , 21.04 und 21.10 Linux-Betriebssysteme.
HINWEIS : Obwohl sie möglicherweise funktionsfähig sind, unterstützt Bio-Rad keine zusätzlichen Linux-Varianten oder andere Versionen der angegebenen Betriebssysteme.
Internetverbindung
HINWEIS : Informationen zur Installation ohne direkten Internetzugang finden Sie im Benutzerhandbuch.
| Erfordernis | ATAC-Seq-Analyse | Kombinatorische ATAC-Seq-Analyse | RNA-Sequenzanalyse | Empfohlen für >=12x Proben |
|---|---|---|---|---|
| CPU | 16 | 16 | 16 | 64 |
| RAM | 64 GB | 128 GB | 64 GB | 512 GB |
| IOPS* | 3.000 | 3.000 | 3.000 | 16.000 |
| I/O-Durchsatz* | 125 Mbit/s | 125 Mbit/s | 125 Mbit/s | 1.000 Mbit/s |
| EBS-Volume-Typ* | gp3 | gp3 | gp3 | gp3 |
*AWS-spezifische Cloud-Computing-Spezifikationen
Nextflow (v22.04.0 bis v23.10.1) oder Nextflow mit Conda
HINWEIS: Geben Sie die Nextflow-Version in der Conda-Installation an, indem Sie den folgenden Befehl verwenden:
conda install –c bioconda nextflow=
Es wird nur eines der folgenden Containerprogramme benötigt: Entweder Docker (>=20.10.7) oder Singularity (>=3.6.4)
HINWEIS: Wenn Sie Docker verwenden, muss Ihr
USERvor der Ausführung der Pipeline zur Docker-Root-Benutzergruppe hinzugefügt werden. Auf gemeinsam genutzten Systemen wie HPC-Clustern ist dies aufgrund von Sicherheitsrisiken möglicherweise nicht möglich und die Pipeline sollte stattdessen mit dem Singularity-Profil (Standard) ausgeführt werden. Der Benutzer muss vor der Verwendung von Omnition bei seinem Systemadministrator überprüfen, ob Docker oder Singularity verfügbar ist.
Um Omnition herunterzuladen und auszuführen, verwenden Sie nextflow, um die neueste Omnition-Version von GitHub abzurufen.
nextflow pull BioRadOpenSource/omnition
Omnition umfasst kleine Demonstrationsdatensätze, um zu überprüfen, ob die Umgebung ordnungsgemäß erstellt wurde und alle Softwareabhängigkeiten vorhanden sind. Um den Erfolg der Installation für jeden Analysetyp zu überprüfen, führen Sie den Nextflow-Befehl für das Containersystem aus, das auf Ihrem Computer installiert ist (Singularity oder Docker).
Um zu überprüfen, ob jeder Analyse-Workflow korrekt installiert ist, führen Sie die folgenden Befehle entweder mit Docker oder Singularity aus.
HINWEIS: Arbeitsdateien (und Ausgabedateien, sofern nicht anders angegeben) werden in demselben Verzeichnis generiert, in dem die Pipeline in der Befehlszeile ausgeführt wurde.
mkdir /home/ubuntu/demo_data cd /home/ubuntu/demo_data
HINWEIS: Die angegebenen Dateipfade dienen lediglich Beispielzwecken
Docker:
# Verify single and mixed species 3’ RNA workflows nextflow run BioRadOpenSource/omnition -profile demo_rna_single,docker --rna.output /home/ubuntu/demo_data/rna nextflow run BioRadOpenSource/omnition -profile demo_rna_mixed_options,docker --rna.output /home/ubuntu/demo_data/rna_mixed # Verify ATAC-seq and combinatorial ATAC-seq workflows nextflow run BioRadOpenSource/omnition -profile demo_atac,docker --atac.output /home/ubuntu/demo_data/atac nextflow run BioRadOpenSource/omnition -profile demo_catac,docker --catac.output /home/ubuntu/demo_data/catac
Singularität:
# Verify single and mixed species 3’ RNA workflows nextflow run BioRadOpenSource/omnition -profile demo_rna_single,standard --rna.output /home/ubuntu/demo_data/rna nextflow run BioRadOpenSource/omnition -profile demo_rna_mixed_options,standard --rna.output /home/ubuntu/demo_data/rna_mixed # Verify ATAC-seq and combinatorial ATAC-seq workflows nextflow run BioRadOpenSource/omnition -profile demo_atac,standard --atac.output /home/ubuntu/demo_data/atac nextflow run BioRadOpenSource/omnition -profile demo_catac,standard --catac.output /home/ubuntu/demo_data/catac
HINWEIS: Bitte beachten Sie die Verwendung von
-und--in den Ausführungsbefehlen. Argumente mit einem einzelnen-am Anfang sind Nextflow-Argumente und solche mit--sind benutzerdefinierte Parameter. Sie können auch das Nextflow-Flag -r verwenden, um ein Git-Tag (z. B. Release), einen Zweig oder einen Hash anzugeben, um die Pipeline an diesem Punkt im Git-Verlauf auszuführen.
HINWEIS: Beim Starten eines Nextflow-Laufs werden zufällig generierte [Adjektivnamen] im Terminal angezeigt. Diese Namen stammen aus einer von Nextflow erstellten Liste. Dies ist eine inhärente Funktion von nextflow und nicht etwas, das von Bio-Rad hinzugefügt wurde.
Wenn der Lauf abgeschlossen ist, sollten Sie eine Meldung sehen, dass er ohne fehlgeschlagene Aufgaben abgeschlossen wurde.
Bevor ein Workflow ausgeführt wird, benötigt Omnition die folgenden Dateien:
Genom-FASTA- und GTF-Dateien von ENSEMBL.
Genomreferenzsequenzen müssen als FASTA-Dateien formatiert sein.
Anmerkungen müssen als GTF-Dateien formatiert sein.
Sequenznamen in den FASTA- und GTF-Dateien müssen übereinstimmen.
Verzeichnis mit Eingabe-FASTQs
HINWEIS: Eingabereferenzdateien können als gzip-Dateien (.gz) komprimiert werden
Omnition ist mit Referenzen von ENSEMBL kompatibel. Die ENSEMBL Human/GRCh38- und Mouse/GRCm39-Referenzen werden von Omnition unterstützt. Andere Arten von ENSEMBL werden nicht unterstützt und von anderen Quellen (NCBI, GENCODE usw.) erstellte Referenzen sind nicht kompatibel.
Mit den folgenden Befehlen können Mensch- und Mausreferenzen abgerufen werden.
mkdir ~/references/human cd ~/references/human
HINWEIS: Die angegebenen Dateipfade dienen lediglich Beispielzwecken
curl -o Homo_sapiens.GRCh38.dna.primary_assembly.fa.gz http://ftp.ensembl.org/pub/release-106/fasta/homo_sapiens/dna/Homo_sapiens.GRCh38.dna.primary_assembly.fa.gz curl -o Homo_sapiens.GRCh38.106.gtf.gz http://ftp.ensembl.org/pub/release-106/gtf/homo_sapiens/Homo_sapiens.GRCh38.106.gtf.gz
mkdir ~/references/mouse cd ~/references/mouse
curl -o Mus_musculus.GRCm39.dna.primary_assembly.fa.gz http://ftp.ensembl.org/pub/release-106/fasta/mus_musculus/dna/Mus_musculus.GRCm39.dna.primary_assembly.fa.gz curl -o Mus_musculus.GRCm39.106.gtf.gz http://ftp.ensembl.org/pub/release-106/gtf/mus_musculus/Mus_musculus.GRCm39.106.gtf.gz
Die Pipeline erfordert eine YAML-formatierte Datei mit Eingabe-/Ausgabepfaden und assayspezifischen Parametern, wenn die Testdaten nicht ausgeführt werden. Eine detaillierte Beschreibung des Dateiinhalts, der verfügbaren Parameter und deren Formatierung finden Sie im Benutzerhandbuch. Beispiel-YAML-Konfigurationen finden Sie im Ordner „example-yamls“ dieses Repos.
Mit Singularität:
nextflow run BioRadOpenSource/omnition -params-file
Mit Docker:
