omnition
v1.1.0
Omnition é um pipeline projetado para processar dados gerados com o kit ddSEQ™ Single-Cell 3' RNA-Seq da Bio-Rad ou ddSEQ™ SureCell ATAC-Seq Library Prep Kit e o protocolo dsciATAC. Ele executa descodificação de barras, alinhamento, fusão de contas, chamada de células e contagem de recursos. A saída é um relatório HTML e arquivos para análise biológica posterior.
Esta página pretende ser um início rápido. Para obter os guias do usuário completos do Omnition, consulte:
Omnition 3' RNA-Seq de célula única
Omnition ATAC-Seq de célula única
Introdução à Omnição
Instalação
Requisitos do sistema
Requisitos de hardware
Requisitos de software
Baixar Omnition
Verifique a instalação
Começando
Configuração YAML
Execute o pipeline ATAC
Executar pipeline de RNA
Genoma humano
Genoma do rato
Referências
Executando Omnition
Resultados
O Omnition Analysis Software utiliza a estrutura Nextflow para conectar processos individuais e executa os processos em ambientes virtuais chamados contêineres usando os programas de contêiner Docker ou Singularity. Depois que o Omnition for instalado em um sistema que atenda aos requisitos mínimos, a integração do Nextflow com GitHub e Docker preparará fluxos de trabalho sem qualquer configuração adicional.
Omnition foi projetado para ser executado em um servidor Linux local, cluster de computação de alto desempenho (HPC) ou máquina virtual em nuvem e foi testado no CentOS 7 e 8 de 64 bits, Amazon Linux 2 e Ubuntu 18.04.6, 20.04 LTS , 21.04 e 21.10 sistemas operacionais Linux.
NOTA : Embora possam ser funcionais, a Bio-Rad não oferece suporte a variantes adicionais do Linux ou outras versões dos sistemas operacionais especificados.
Conexão com a Internet
NOTA : Para instalação sem acesso direto à Internet, consulte o manual do usuário.
| Exigência | Análise sequencial ATAC | Análise combinatória ATAC seq | Análise sequencial de RNA | Recomendado para amostras >=12x |
|---|---|---|---|---|
| CPU | 16 | 16 | 16 | 64 |
| BATER | 64GB | 128GB | 64GB | 512GB |
| IOPS* | 3.000 | 3.000 | 3.000 | 16.000 |
| Taxa de transferência de E/S* | 125Mbps | 125Mbps | 125Mbps | 1.000Mbps |
| Tipo de volume EBS* | GP3 | GP3 | GP3 | GP3 |
*Especificações específicas de computação em nuvem da AWS
Nextflow (v22.04.0 a v23.10.1) ou Nextflow com Conda
NOTA: Especifique a versão do Nextflow na instalação do Conda usando o seguinte comando:
conda install –c bioconda nextflow=
Apenas um dos seguintes programas contêineres é necessário: Docker (>=20.10.7) ou Singularity (>=3.6.4)
NOTA: Se estiver usando o Docker, seu
USERdeverá ser adicionado ao grupo de usuários root do docker antes de executar o pipeline. Em sistemas compartilhados, como clusters HPC, isso pode não ser possível devido a riscos de segurança e o pipeline deve ser executado usando o perfil Singularity (padrão). O usuário deve verificar com o administrador do sistema se o Docker ou o Singularity estão disponíveis antes de usar o Omnition.
Para baixar e executar o Omnition, use nextflow para recuperar a versão mais recente do Omnition do GitHub.
nextflow pull BioRadOpenSource/omnition
Omnition inclui pequenos conjuntos de dados de demonstração para verificar se o ambiente foi construído corretamente e se todas as dependências de software estão implementadas. Para verificar o sucesso da instalação para cada tipo de análise, execute o comando Nextflow para o sistema de contêiner instalado em seu computador (Singularity ou Docker).
Para verificar se cada fluxo de trabalho de análise está instalado corretamente, execute os comandos a seguir com Docker ou Singularity.
NOTA: Os arquivos de trabalho (e os arquivos de saída, a menos que especificado de outra forma) serão gerados no mesmo diretório a partir do qual o pipeline foi executado na linha de comando.
mkdir /home/ubuntu/demo_data cd /home/ubuntu/demo_data
NOTA: Os caminhos de arquivo especificados são para fins de exemplo
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
Singularidade:
# 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
NOTA: Observe o uso de
-e--nos comandos de execução. Argumentos com um único-na frente são argumentos Nextflow e aqueles com--são parâmetros definidos pelo usuário. Você também pode usar o sinalizador Nextflow -r para especificar uma tag git (ou seja, release), branch ou hash para executar o pipeline naquele ponto do histórico do git.
NOTA: Ao iniciar uma execução do nextflow, haverá [adjective_names] gerados aleatoriamente que aparecerão no terminal. Esses nomes fazem parte de uma lista preparada pela Nextflow. Este é um recurso inerente ao nextflow, não algo adicionado pela Bio-Rad.
Quando a execução terminar, você verá uma mensagem informando que ela foi concluída sem nenhuma tarefa com falha.
Antes de executar um fluxo de trabalho, o Omnition requer a execução dos seguintes arquivos:
Arquivos do genoma FASTA e GTF do ENSEMBL.
As sequências de referência do genoma devem ser formatadas como arquivos FASTA.
As anotações devem ser formatadas como arquivos GTF.
Os nomes das sequências nos arquivos FASTA e GTF devem corresponder.
Diretório com FASTQs de entrada
NOTA: Os arquivos de referência de entrada podem ser compactados como arquivos gzip (.gz)
Omnition é compatível com referências do ENSEMBL. As referências ENSEMBL Human/GRCh38 e Mouse/GRCm39 são suportadas pela Omnition. Outras espécies do ENSEMBL não são suportadas e referências produzidas por outras fontes (NCBI, GENCODE, etc.) não são compatíveis.
Referências humanas e de mouse podem ser obtidas com os seguintes comandos.
mkdir ~/references/human cd ~/references/human
NOTA: Os caminhos de arquivo especificados são para fins de exemplo
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
O pipeline requer um arquivo formatado em YAML com caminhos de entrada/saída e parâmetros específicos do ensaio quando não estiver executando os dados de teste. Uma descrição detalhada do conteúdo do arquivo, parâmetros disponíveis e como formatá-los pode ser encontrada no manual do usuário. Exemplos de configurações YAML podem ser encontrados na pasta example-yamls deste repositório.
Com Singularidade:
nextflow run BioRadOpenSource/omnition -params-file
Com Docker:
