Difference between revisions of "Preparing read data"
Thomas Admin (talk | contribs) |
|||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The best format to present short read alignments to GenomeView is the BAM format. You need to have your read data in this format and it has to be aligned. | + | {{TOC|align=right}} |
| + | The best format to present short read alignments to GenomeView is the SAM/BAM format. You need to have your read data in this format and it has to be aligned to a reference genome. | ||
== Aligning reads == | == Aligning reads == | ||
| Line 6: | Line 7: | ||
If you need help aligning your reads, you may want to have a look at the [[Recipe to align reads]] to get some ideas. | If you need help aligning your reads, you may want to have a look at the [[Recipe to align reads]] to get some ideas. | ||
| − | == | + | == Sorting and indexing == |
| − | + | Before you can visualize read data you need to prepare the data. This needs to be done because those files are generally huge and we do not want to read the complete file if we're only looking at a small portion of it. | |
| + | |||
| + | There are two things to prepare data fresh from the aligner. | ||
# Sort reads based on genomic coordinates | # Sort reads based on genomic coordinates | ||
# Index sorted reads. | # Index sorted reads. | ||
| − | === | + | |
| − | You need to have a | + | === With Picard (OS independent, recommended) === |
| + | You need to have a a recent version of Java installed and you need to run these commands on the [[command-line]]. There are download links with each program where you can fetch the exact version that these manual pages were tested with. Alternatively, you may want to install a more recent version of [http://picard.sourceforge.net/ Picard]. | ||
In this example we have a read alignment in BAM format called 'alignment.sam'. We use the program [http://picard.sourceforge.net/command-line-overview.shtml#SortSam SortSam] from Picard to sort the file by coordinates. This also works if your aligner gives you a BAM file as output, i.e. 'alignment.bam' | In this example we have a read alignment in BAM format called 'alignment.sam'. We use the program [http://picard.sourceforge.net/command-line-overview.shtml#SortSam SortSam] from Picard to sort the file by coordinates. This also works if your aligner gives you a BAM file as output, i.e. 'alignment.bam' | ||
| − | + | '''Sorting''' | |
| − | java - | + | The instruction below will sort the SAM file by coordinate. |
| − | + | java -Xmx500m -jar SortSam.jar I=aligned.sam O=sorted.bam SO=coordinate | |
| + | [http://genomeview.org/loki/picard-tools-recent/SortSam.jar Download SortSam.jar] | ||
| + | |||
| + | Important: | ||
| + | # You may need to put the full path for SortSam.jar to the location where you installed the Picard programs. | ||
| + | # You may need to put the full path to where the aligned.sam file sits and where you want the sorted.bam file to end up. | ||
| + | # You have to make sure to replace 'alignment.sam' with the actual name of you aligned SAM/BAM file. | ||
| + | # You have to make sure to replace 'sorted.bam' with the actual name that you want your sorted file to have. | ||
| + | |||
| + | Sanity checks: | ||
| + | # Make sure there are no errors reported on the console when running this instruction. | ||
| + | # Make sure that you now have a file 'sorted.bam' and that it's not completely empty, i.e. it has a size > 0 | ||
| + | |||
| + | '''Indexing''' | ||
| + | After you have sorted the file, you can index the resulting BAM file with the instruction below: | ||
| + | |||
| + | java -Xmx500m -jar BuildBamIndex.jar I=sorted.bam | ||
| + | [http://genomeview.org/loki/picard-tools-recent/BuildBamIndex.jar Download BuildBamIndex.jar] | ||
| − | === | + | Important: |
| − | Steps to get from the various aligner formats to the SAM format are available on the SAMtools website. | + | # You may need to put the full path for BuildBamIndex.jar to the location where you installed the Picard programs. |
| + | # You may need to put the full path to where the 'sorted.bam' file sits. | ||
| + | |||
| + | |||
| + | Sanity checks: | ||
| + | # Make sure there are no errors reported on the console when running this instruction. | ||
| + | # Make sure that you now have a file 'sorted.bam.'''bai'''' and that it's not completely empty, i.e. it has a size > 0. This file will be created in the same directory as the 'sorted.bam' file. | ||
| + | |||
| + | === With SAMtools (Mac OS and Linux) === | ||
| + | Steps to get from the various aligner formats to the SAM format are available on the [http://samtools.sourceforge.net/ SAMtools website]. | ||
| + | |||
| + | You need to have SAMtools installed. | ||
Steps to go from SAM to indexed BAM. | Steps to go from SAM to indexed BAM. | ||
| − | samtools faidx reference.fasta (will create reference.fasta.fai for the next step) | + | samtools faidx reference.fasta (will create reference.fasta.fai for the next step) |
| − | samtools view -bS -t reference.fasta.fai alignment.sam -o alignment.bam | + | samtools view -bS -t reference.fasta.fai alignment.sam -o alignment.bam |
| − | samtools sort alignment.bam sorted (will create sorted.bam) | + | samtools sort alignment.bam sorted (will create sorted.bam) |
| − | samtools index sorted.bam (will create sorted.bam.bai, which is read by GenomeView together with the bam file) | + | samtools index sorted.bam (will create sorted.bam.bai, which is read by GenomeView together with the bam file) |
| + | |||
| + | == Downsampling data == | ||
| + | Sometimes you don't want to look at all reads, but just at a fraction. This can be done by downsampling you BAM files before indexing. | ||
| + | |||
| + | java -Xmx500m -jar DownsampleSam.jar I=sorted.bam O=downsample.bam P=0.1 | ||
| + | [http://genomeview.org/loki/picard-tools-recent/DownsampleSam.jar Download DownsampleSam.jar] | ||
| + | |||
| + | |||
| + | |||
| + | The I parameter is the input file | ||
| + | |||
| + | The O parameter is the output file | ||
| + | |||
| + | The P parameter is the probability that a read is retained, so 0.1 means that 10% of the reads are kept. | ||
| Line 42: | Line 88: | ||
=== Variants === | === Variants === | ||
If you are investigating SNPs or other genetic variants, you also may want to [[Recipe variant calls|create variant calls]]. | If you are investigating SNPs or other genetic variants, you also may want to [[Recipe variant calls|create variant calls]]. | ||
| + | |||
| + | |||
| + | [[Category:User]][[Category:Platform]] | ||
Latest revision as of 16:30, 24 October 2013
The best format to present short read alignments to GenomeView is the SAM/BAM format. You need to have your read data in this format and it has to be aligned to a reference genome.
Aligning reads
GenomeView is a visualization tool and does not do the computationally intensive read alignment. There are however dozens of tools already available to do this job.
If you need help aligning your reads, you may want to have a look at the Recipe to align reads to get some ideas.
Sorting and indexing
Before you can visualize read data you need to prepare the data. This needs to be done because those files are generally huge and we do not want to read the complete file if we're only looking at a small portion of it.
There are two things to prepare data fresh from the aligner.
- Sort reads based on genomic coordinates
- Index sorted reads.
With Picard (OS independent, recommended)
You need to have a a recent version of Java installed and you need to run these commands on the command-line. There are download links with each program where you can fetch the exact version that these manual pages were tested with. Alternatively, you may want to install a more recent version of Picard.
In this example we have a read alignment in BAM format called 'alignment.sam'. We use the program SortSam from Picard to sort the file by coordinates. This also works if your aligner gives you a BAM file as output, i.e. 'alignment.bam'
Sorting The instruction below will sort the SAM file by coordinate.
java -Xmx500m -jar SortSam.jar I=aligned.sam O=sorted.bam SO=coordinate
Important:
- You may need to put the full path for SortSam.jar to the location where you installed the Picard programs.
- You may need to put the full path to where the aligned.sam file sits and where you want the sorted.bam file to end up.
- You have to make sure to replace 'alignment.sam' with the actual name of you aligned SAM/BAM file.
- You have to make sure to replace 'sorted.bam' with the actual name that you want your sorted file to have.
Sanity checks:
- Make sure there are no errors reported on the console when running this instruction.
- Make sure that you now have a file 'sorted.bam' and that it's not completely empty, i.e. it has a size > 0
Indexing After you have sorted the file, you can index the resulting BAM file with the instruction below:
java -Xmx500m -jar BuildBamIndex.jar I=sorted.bam
Important:
- You may need to put the full path for BuildBamIndex.jar to the location where you installed the Picard programs.
- You may need to put the full path to where the 'sorted.bam' file sits.
Sanity checks:
- Make sure there are no errors reported on the console when running this instruction.
- Make sure that you now have a file 'sorted.bam.bai' and that it's not completely empty, i.e. it has a size > 0. This file will be created in the same directory as the 'sorted.bam' file.
With SAMtools (Mac OS and Linux)
Steps to get from the various aligner formats to the SAM format are available on the SAMtools website.
You need to have SAMtools installed.
Steps to go from SAM to indexed BAM.
samtools faidx reference.fasta (will create reference.fasta.fai for the next step)
samtools view -bS -t reference.fasta.fai alignment.sam -o alignment.bam
samtools sort alignment.bam sorted (will create sorted.bam)
samtools index sorted.bam (will create sorted.bam.bai, which is read by GenomeView together with the bam file)
Downsampling data
Sometimes you don't want to look at all reads, but just at a fraction. This can be done by downsampling you BAM files before indexing.
java -Xmx500m -jar DownsampleSam.jar I=sorted.bam O=downsample.bam P=0.1
The I parameter is the input file
The O parameter is the output file
The P parameter is the probability that a read is retained, so 0.1 means that 10% of the reads are kept.
Summary visualizations
Coverage plots
If you are primarily interested in the read coverage and not in individual reads, you may want to create coverage plots.
Variants
If you are investigating SNPs or other genetic variants, you also may want to create variant calls.