# nf-core/ncrnannotator
```{note}
**nf-core/ncrnannotator is under construction and has not yet had its first release.** The
documentation linked below tracks the `dev` branch:
```
**nf-core/ncrnannotator** is a bioinformatics pipeline for annotating non-coding RNA (ncRNA) genes
in genome assemblies. It searches a genome with [Rfam](https://rfam.org) covariance models using
[Infernal](https://eddylab.org/infernal/) and reports the ncRNA loci it finds in GTF, GFF3 and BED
formats. It is developed by the RNA Resources team at EMBL-EBI as part of the
[nf-core](https://nf-co.re) community of curated [Nextflow](https://www.nextflow.io/) pipelines.
## What the pipeline does
1. Filters the Rfam covariance models to those suited to the chosen annotation mode
2. Splits the genome into chunks so they can be searched in parallel
3. Searches each chunk with Infernal `cmsearch`
4. Removes overlapping hits and applies each Rfam family's gathering (GA) threshold
5. Exports the annotation in GTF, GFF3 and BED formats
6. Summarises the run in a [MultiQC](https://multiqc.info/) report
## Annotation modes
The `--mode` parameter sets which Rfam families are searched and how large the genome chunks are:
| Mode | Use for | Rfam families |
| --- | --- | --- |
| `ensembl-vertebrates` | Vertebrate genomes | A curated subset (snRNA, snoRNA, rRNA, SRP RNA, Y RNA, RNase P, vault RNA) |
| `ensembl-invertebrates` | Invertebrate genomes | A curated subset, with smaller chunks for compact genomes |
| `mgnify-assembly` | Metagenomic assemblies | All families, including bacterial and archaeal rRNA |
| `full` | Any eukaryotic genome | All families, without prokaryotic rRNA |
## Usage
The pipeline takes a genome FASTA file along with Rfam covariance models and seed alignment files,
which can be downloaded from the [Rfam FTP site](https://ftp.ebi.ac.uk/pub/databases/Rfam/CURRENT/).
No samplesheet is needed:
```bash
nextflow run nf-core/ncrnannotator -r dev \
-profile \
--fasta genome.fa \
--mode ensembl-vertebrates \
--rfam_cm Rfam.cm \
--rfam_seed Rfam.seed \
--outdir
```
For all options and a description of the output files, see the
[usage](https://nf-co.re/ncrnannotator/dev/docs/usage/),
[parameter](https://nf-co.re/ncrnannotator/dev/parameters/) and
[output](https://nf-co.re/ncrnannotator/dev/docs/output/) documentation.
## Credits and support
nf-core/ncrnannotator was written by Pedro Madrigal, Hanh Hoang and Victoria Begley from the RNA
Resources team at EMBL-EBI.
- Source code:
- Get help on the
[`#ncrnannotator` Slack channel](https://nfcore.slack.com/channels/ncrnannotator)
(join with [this invite](https://nf-co.re/join/slack))