omnition
v1.1.0
Omnition est un pipeline conçu pour traiter les données générées avec le kit ddSEQ™ Single-Cell 3' RNA-Seq de Bio-Rad ou le kit de préparation de bibliothèque ddSEQ™ SureCell ATAC-Seq et le protocole dsciATAC. Il effectue le débarcodage, l'alignement, la fusion de billes, l'appel de cellules et le comptage de fonctionnalités. La sortie est un rapport HTML et des fichiers pour l’analyse biologique en aval.
Cette page est destinée à être un démarrage rapide. Pour les guides d'utilisation complets d'Omnition, veuillez consulter :
Omnition ARN-Seq unicellulaire 3'
Omnition ATAC-Seq unicellulaire
Introduction à l'Omnition
Installation
Configuration système requise
Exigences matérielles
Exigences logicielles
Télécharger Omnition
Vérifier l'installation
Commencer
ConfigurationYAML
Exécuter le pipeline ATAC
Exécuter un pipeline d'ARN
Génome humain
Génome de la souris
Références
Exécution d'Omnition
Sorties
Omnition Analysis Software utilise le framework Nextflow pour connecter des processus individuels et exécute les processus dans des environnements virtuels appelés conteneurs à l'aide des programmes de conteneur Docker ou Singularity. Une fois Omnition installé sur un système répondant aux exigences minimales, l'intégration de Nextflow avec GitHub et Docker préparera les flux de travail sans aucune configuration supplémentaire.
Omnition est conçu pour fonctionner sur un serveur Linux local, un cluster de calcul haute performance (HPC) ou une machine virtuelle cloud, et a été testé sur CentOS 7 et 8 64 bits, Amazon Linux 2 et Ubuntu 18.04.6, 20.04 LTS. , 21.04 et 21.10 pour les systèmes d'exploitation Linux.
REMARQUE : Bien qu'ils puissent être fonctionnels, Bio-Rad ne prend pas en charge les variantes Linux supplémentaires ou les autres versions des systèmes d'exploitation spécifiés.
Connexion Internet
REMARQUE : Pour une installation sans accès direct à Internet, veuillez consulter le manuel d'utilisation.
| Exigence | Analyse de séquence ATAC | Analyse combinatoire des séquences ATAC | Analyse de séquence d'ARN | Recommandé pour >=12x échantillons |
|---|---|---|---|---|
| Processeur | 16 | 16 | 16 | 64 |
| BÉLIER | 64 Go | 128 Go | 64 Go | 512 Go |
| IOPS* | 3 000 | 3 000 | 3 000 | 16 000 |
| Débit d'E/S* | 125 Mbps | 125 Mbps | 125 Mbps | 1 000 Mbps |
| Type de volume EBS* | gp3 | gp3 | gp3 | gp3 |
*Spécifications spécifiques au cloud computing AWS
Nextflow (v22.04.0 à v23.10.1) ou Nextflow avec Conda
REMARQUE : Spécifiez la version de Nextflow dans l'installation de Conda à l'aide de la commande suivante :
conda install –c bioconda nextflow=
Un seul des programmes conteneurs suivants est nécessaire : Soit Docker (>=20.10.7), soit Singularity (>=3.6.4).
REMARQUE : si vous utilisez Docker, votre
USERdoit être ajouté au groupe d'utilisateurs racine de Docker avant d'exécuter le pipeline. Sur les systèmes partagés, tels que les clusters HPC, cela peut ne pas être possible en raison de risques de sécurité et le pipeline doit plutôt être exécuté à l'aide du profil Singularity (par défaut). L'utilisateur doit vérifier auprès de son administrateur système que Docker ou Singularity est disponible avant d'utiliser Omnition.
Pour télécharger et exécuter Omnition, utilisez nextflow pour récupérer la dernière version d'Omnition depuis GitHub.
nextflow pull BioRadOpenSource/omnition
Omnition comprend de petits ensembles de données de démonstration pour vérifier que l'environnement a été correctement construit et que toutes les dépendances logicielles sont en place. Pour vérifier le succès de l'installation pour chaque type d'analyse, exécutez la commande Nextflow pour le système de conteneur installé sur votre ordinateur (Singularity ou Docker).
Pour vérifier que chaque workflow d'analyse est correctement installé, exécutez les commandes suivantes avec Docker ou Singularity.
REMARQUE : Les fichiers de travail (et les fichiers de sortie, sauf indication contraire) seront générés dans le même répertoire à partir duquel le pipeline a été exécuté sur la ligne de commande.
mkdir /home/ubuntu/demo_data cd /home/ubuntu/demo_data
REMARQUE : Les chemins de fichiers spécifiés sont à titre d'exemple.
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é:
# 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
REMARQUE : veuillez noter l'utilisation de
-et--dans les commandes d'exécution. Les arguments avec un seul-devant sont des arguments Nextflow et ceux avec--sont des paramètres définis par l'utilisateur. Vous pouvez également utiliser l'indicateur Nextflow -r pour spécifier une balise git (c'est-à-dire une version), une branche ou un hachage pour exécuter le pipeline à ce stade de l'historique git.
REMARQUE : lors du lancement d'une exécution nextflow, un [adjective_names] généré de manière aléatoire apparaîtra dans le terminal. Ces noms proviennent d'une liste préparée par Nextflow. Il s'agit d'une fonctionnalité inhérente à nextflow, et non d'un élément ajouté par Bio-Rad.
Une fois l'exécution terminée, vous devriez voir un message indiquant qu'elle s'est terminée sans échec de tâche.
Avant d'exécuter un workflow, Omnition nécessite l'exécution des fichiers suivants :
Fichiers Génome FASTA et GTF de l'ENSEMBL.
Les séquences de référence du génome doivent être formatées sous forme de fichiers FASTA.
Les annotations doivent être formatées sous forme de fichiers GTF.
Les noms de séquence dans les fichiers FASTA et GTF doivent correspondre.
Répertoire avec les FASTQ d'entrée
REMARQUE : les fichiers de référence d'entrée peuvent être compressés sous forme de fichiers gzip (.gz).
Omnition est compatible avec les références de l'ENSEMBL. Les références ENSEMBL Human/GRCh38 et Mouse/GRCm39 sont supportées par Omnition. Les autres espèces de l'ENSEMBL ne sont pas supportées et les références produites par d'autres sources (NCBI, GENCODE, etc.) ne sont pas compatibles.
Les références humaines et souris peuvent être obtenues avec les commandes suivantes.
mkdir ~/references/human cd ~/references/human
REMARQUE : Les chemins de fichiers spécifiés sont à titre d'exemple.
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
Le pipeline nécessite un fichier au format YAML avec des chemins d'entrée/sortie et des paramètres spécifiques au test lorsqu'il n'exécute pas les données de test. Une description détaillée du contenu du fichier, des paramètres disponibles et de la manière de les formater peut être trouvée dans le manuel d'utilisation. Des exemples de configurations YAML peuvent être trouvés dans le dossier example-yamls de ce dépôt.
Avec singularité :
nextflow run BioRadOpenSource/omnition -params-file
Avec Docker :
