Honfi001 at 08:57, 1 October 2026

2026-10-01T08:57:45Z

← Older revision		Revision as of 08:57, 1 October 2026
Line 1:		Line 1:
	{{DISPLAYTITLE:JBrowse 2}}		{{DISPLAYTITLE:JBrowse 2}}

	JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from ~~Open OnDemand~~, and it will show the data you already have on the cluster.		JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from the [https://apps.anunna.wur.nl Anunna Apps Portal], and it will show the data you already have on the cluster.

	This page explains what the JBrowse 2 app is, what each option on its form means, and which kinds of files it can show. It does not explain how to use JBrowse 2 itself. For that, see the [https://jbrowse.org/jb2/docs/ JBrowse 2 documentation].		This page explains what the JBrowse 2 app is, what each option on its form means, and which kinds of files it can show. It does not explain how to use JBrowse 2 itself. For that, see the [https://jbrowse.org/jb2/docs/ JBrowse 2 documentation].

Honfi001 at 08:55, 1 October 2026

2026-10-01T08:55:54Z

← Older revision		Revision as of 08:55, 1 October 2026
Line 1:		Line 1:
	{{DISPLAYTITLE:~~JBrowse2~~}}		{{DISPLAYTITLE:JBrowse 2}}

	JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster.		JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster.

Honfi001 at 08:55, 1 October 2026

2026-10-01T08:55:04Z

← Older revision		Revision as of 08:55, 1 October 2026
Line 1:		Line 1:
	{{DISPLAYTITLE:~~JBrowse 2~~}}		{{DISPLAYTITLE:JBrowse2}}

	JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster.		JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster.

Honfi001: Created page with "{{DISPLAYTITLE:JBrowse 2}} JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster. This page explains what the JBrowse 2 app is, what each option on its form means, and which kinds of files it can show. It does not explain how to use JBrowse 2 itself. For that, see the [https://jbrowse.org/jb2/docs/ JBrowse 2 documentation]. == Introduction == === What JBrow..."

2026-10-01T08:46:32Z

Created page with "{{DISPLAYTITLE:JBrowse 2}} JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster. This page explains what the JBrowse 2 app is, what each option on its form means, and which kinds of files it can show. It does not explain how to use JBrowse 2 itself. For that, see the [https://jbrowse.org/jb2/docs/ JBrowse 2 documentation]. == Introduction == === What JBrow..."

New page

{{DISPLAYTITLE:JBrowse 2}}

JBrowse 2 is a genome browser that runs in your web browser. On Anunna you can start it from Open OnDemand, and it will show the data you already have on the cluster.

This page explains what the JBrowse 2 app is, what each option on its form means, and which kinds of files it can show. It does not explain how to use JBrowse 2 itself. For that, see the [https://jbrowse.org/jb2/docs/ JBrowse 2 documentation].

== Introduction ==

=== What JBrowse 2 is ===

A genome browser works a bit like a map application, but for a genome. The reference genome is the map. Your data is drawn on top of it, as '''tracks''': one track per file. You can zoom out to see a whole chromosome, or zoom in to see single bases.

JBrowse 2 can show, for example:

* sequencing reads aligned to the genome
* variants, such as SNPs
* coverage and other signals along the genome
* genes and other annotations

=== Why run it on Anunna ===

Sequencing data is large. A single alignment file can be many gigabytes, and you would not want to download it just to look at one gene.

With this app, you do not have to. JBrowse 2 runs on a compute node, right next to your data on [[Filesystems | Lustre]]. When you look at a region, only the small part of each file that covers that region is read. Nothing is copied.

Your files are also safe. The app can only '''read''' your data. It never changes, moves or adds anything in your folders.

== Starting the app ==

Go to the [https://apps.anunna.wur.nl Anunna Apps Portal], and find the '''JBrowse 2''' tile under ''All Applications''. Click on the button or selected it from the drop down, this will lead you to a form. Fill in the form, which is explained below, and click '''Launch'''.

Your session waits in the queue like any other job. Once it is running, a '''Connect to JBrowse 2''' button appears. Click it, and JBrowse 2 opens in a new browser tab with your data already loaded.

== The form ==

The form asks for two things about your data, the reference genome and a data folder, and a few things about the job itself.

{| class="wikitable"
! Option !! What it means !! Default
|-
| Maximum number of hours || How long the session may run. It stops after this time, even if you are still using it. Choose between 1 and 8 hours. || 4
|-
| Reference genome (indexed FASTA) || The genome your data is aligned to. '''Required.''' || —
|-
| Data folder to browse || The folder that holds your data files. ''Optional.'' || the folder of the reference
|-
| Number of CPU cores || How many cores the session gets. || 2
|-
| Total memory || How much memory the session gets. || 8 GB
|-
| Comment || A note for your job, for example a project number. || empty
|-
| SLURM options || Extra options for the job scheduler. Leave this empty if you are not sure. || empty
|-
| Email when started || Sends you an email when the session is ready. || off
|}

=== Reference genome ===

This is the most important choice. The reference is the "map" that everything else is drawn on, so '''all your data must be aligned to this same reference'''. If you choose a different version of the genome than the one your reads were aligned to, the tracks will not line up.

Use the browse button next to the field and choose a FASTA file. The file must:

* end in <code>.fa</code>, <code>.fasta</code> or <code>.fna</code>, or in <code>.fa.gz</code> (and so on) if it is compressed with <code>bgzip</code>
* have an index file next to it, with the same name plus <code>.fai</code>, for example <code>genome.fa</code> and <code>genome.fa.fai</code>
* if it is compressed, also have a <code>.gzi</code> file next to it

If the index is missing, the session stops right away and tells you so. See [[#Preparing your files|Preparing your files]] for how to make one.

=== Data folder ===

This is the folder with the files you want to see. Use the browse button next to the field and choose a folder, not a file.

The app looks through this folder '''and its subfolders''', up to four levels deep. Every file it can show becomes a track. Tracks are grouped by the subfolder they were found in, so a tidy folder gives you a tidy track list.

You can leave this field empty. The app then uses the folder that holds your reference genome. That is handy when the reference and the data are kept together.

A few tips:

* Choose the folder that holds the data you want to see, not a very large folder above it. The app adds at most 500 tracks. If a folder has more files than that, the rest are left out.
* Hidden files and folders, whose names start with a dot, are skipped.
* Subfolders that are only a link (a symlink) to somewhere else are not searched. Choose the real folder instead.

=== Cores and memory ===

A genome browser needs very little. JBrowse 2 does its drawing in your own web browser. The compute node only reads your files and sends the pieces you look at. The defaults, 2 cores and 8 GB, are enough for almost everyone. Asking for more will not make it faster, and it can make your session wait longer in the queue.

== Supported data ==

The app can show these kinds of files. Most of them need an '''index''' file next to them. The index is a small file that tells JBrowse 2 where each part of the genome is stored in the big file, so it can jump straight to the region you are looking at.

{| class="wikitable"
! Data !! File name ends in !! Index needed next to it !! Shown as
|-
| Aligned reads (BAM) || <code>.bam</code> || <code>.bai</code> or <code>.csi</code> || reads
|-
| Aligned reads (CRAM) || <code>.cram</code> || <code>.crai</code> || reads
|-
| Variants (VCF) || <code>.vcf.gz</code> || <code>.tbi</code> or <code>.csi</code> || variants
|-
| Annotation (GFF3) || <code>.gff3.gz</code> or <code>.gff.gz</code> || <code>.tbi</code> or <code>.csi</code> || features, such as genes
|-
| Regions (BED) || <code>.bed.gz</code> || <code>.tbi</code> or <code>.csi</code> || features
|-
| Signal (BigWig) || <code>.bw</code> or <code>.bigwig</code> || none || a graph, such as coverage
|-
| Regions (BigBed) || <code>.bb</code> or <code>.bigbed</code> || none || features
|}

Some things to know:

* '''Files without an index are skipped.''' The session still starts, but that file will not be in the track list.
* '''VCF, GFF3 and BED files must be compressed with <code>bgzip</code>.''' A plain <code>.vcf</code>, <code>.gff3</code> or <code>.bed</code> file is not shown. Note that <code>bgzip</code> is not the same as normal <code>gzip</code>: a file compressed with <code>gzip</code> cannot be indexed.
* '''CRAM files use the reference you chose''' to rebuild the reads. So for CRAM, choose the same reference genome the CRAM file was made with.
* Other file types in the folder, such as FASTQ or plain text, are simply ignored.

== Preparing your files ==

If your files are not indexed yet, you need to do this once. After that, the index files stay next to your data and you never need to do it again.

The tools you need are in the same module the app uses. Please do this in a job, not on the login node. A small job script is enough:

<syntaxhighlight lang="bash">
#!/bin/bash
#SBATCH --job-name=index-for-jbrowse
#SBATCH --time=1:00:00
#SBATCH --mem=4G
#SBATCH --cpus-per-task=1

module load 2025 JBrowse2/4.3.0-GCC-14.2.0

# Go to the folder that holds your files
cd /lustre/path/to/your/data

# The reference genome: makes genome.fa.fai
samtools faidx genome.fa

# Aligned reads: makes sample1.bam.bai
samtools index sample1.bam

# Variants: compress, then index. Makes variants.vcf.gz and variants.vcf.gz.tbi
bgzip variants.vcf
tabix -p vcf variants.vcf.gz
</syntaxhighlight>

Save this as, for example, <code>index.sh</code>, change the folder and file names to your own, and submit it with <code>sbatch index.sh</code>.

Use the line that matches each of your files:

{| class="wikitable"
! File !! Command
|-
| Reference genome || <code>samtools faidx genome.fa</code>
|-
| BAM or CRAM || <code>samtools index sample1.bam</code>
|-
| VCF || <code>bgzip variants.vcf</code>, then <code>tabix -p vcf variants.vcf.gz</code>
|-
| GFF3 || <code>bgzip genes.gff3</code>, then <code>tabix -p gff genes.gff3.gz</code>
|-
| BED || <code>bgzip regions.bed</code>, then <code>tabix -p bed regions.bed.gz</code>
|}

Indexing only works on files that are '''sorted by position''' along the genome. Alignment files made by most pipelines already are. If <code>samtools index</code> or <code>tabix</code> complains that the file is not sorted, sort it first, for example with <code>samtools sort</code> for a BAM file.

== If a file is missing from the track list ==

When the session starts, the app writes a short report in the session's <code>output.log</code>. You can open it from the session card in Open OnDemand, through the link to the session folder. The report lists every track that was added, and every file that was skipped, with the reason.

The usual reasons are:

* the index file is missing, or has a different name than the data file
* the file ends in <code>.vcf</code>, <code>.gff3</code> or <code>.bed</code> instead of <code>.vcf.gz</code> and so on
* the file is more than four folders below the data folder you chose
* the folder had more than 500 files the app could show

If the session does not start at all, the same log tells you why. Most often the reference genome has no <code>.fai</code> index, or the path you chose is not a FASTA file.

JBrowse2 - Revision history

Honfi001 at 08:57, 1 October 2026

Honfi001 at 08:55, 1 October 2026

Honfi001 at 08:55, 1 October 2026