Difference between revisions of "SAMtools"
(Created page with "== Introduction == Samtools is a suite of programs for interacting with high-throughput sequencing data. It consists of three separate repositories: * '''Samtools''' - Readi...") |
Schwietzer (talk | contribs) |
||
(12 intermediate revisions by 3 users not shown) | |||
Line 10: | Line 10: | ||
== Installed Version == | == Installed Version == | ||
The currently installed version is . | The currently installed versions are: | ||
On environment ''hpc-uniol-env'' | |||
SAMtools/0.1.16 | |||
SAMtools/1.3.1 | |||
SAMtools/1.3.1-intel-2016b | |||
SAMtools/1.7-foss-2016b | |||
SAMtools/1.8-intel-2016b | |||
On environment ''hpc-env/6.4'' | |||
SAMtools/1.7-foss-2017b | |||
SAMtools/1.8-intel-2018a | |||
SAMtools/1.9-foss-2017b | |||
On environment ''hpc-env/8.3'' | |||
SAMtools/0.1.19-foss-2019b | |||
SAMtools/1.9-foss-2019b | |||
SAMtools/1.9-GCC-8.3.0 | |||
SAMtools/1.10-iccifort-2019b | |||
== Using SAMtools on the HPC cluster == | |||
If you want to use the newest SAMtools on the HPC cluster, you will have to load the most current environment as well as the module first. You can do that with the command | |||
module load hpc-env/8.3 # as the time of writing (June 2021) this is the most up to date environment | |||
module load SAMtools # Without a specified version, this loads the default version, which mostly is just the most current installed module version | |||
Since there are multiple version of SAMtools installed, you can specify your needed version by changing the last part of the "module load"-command, e.g. | |||
module load SAMtools/0.1.19-foss-2019b | |||
would load version '''0.1.19''' instead of the most current version. | |||
After loading any of the mentioned SAMtools modules, you can call the actual software executable by just typing in: | |||
samtools <argument> <target_file> | |||
If you need some basic help on the softzware syntax, you can call <tt>samtools</tt> without any arguments to get an overview about the different supported commands. | |||
== Documentation == | == Documentation == | ||
The full documentation can be found [ here]. | The full documentation can be found [http://www.htslib.org/doc/ here]. |
Latest revision as of 09:50, 29 November 2022
Introduction
Samtools is a suite of programs for interacting with high-throughput sequencing data. It consists of three separate repositories:
- Samtools - Reading/writing/editing/indexing/viewing SAM/BAM/CRAM format
- BCFtools - Reading/writing BCF2/VCF/gVCF files and calling/filtering/summarising SNP and short indel sequence variants
- HTSlib - A C library for reading/writing high-throughput sequencing data
Samtools and BCFtools both use HTSlib internally, but these source packages contain their own copies of htslib so they can be built independently.
Installed Version
The currently installed versions are:
On environment hpc-uniol-env SAMtools/0.1.16 SAMtools/1.3.1 SAMtools/1.3.1-intel-2016b SAMtools/1.7-foss-2016b SAMtools/1.8-intel-2016b
On environment hpc-env/6.4 SAMtools/1.7-foss-2017b SAMtools/1.8-intel-2018a SAMtools/1.9-foss-2017b
On environment hpc-env/8.3 SAMtools/0.1.19-foss-2019b SAMtools/1.9-foss-2019b SAMtools/1.9-GCC-8.3.0 SAMtools/1.10-iccifort-2019b
Using SAMtools on the HPC cluster
If you want to use the newest SAMtools on the HPC cluster, you will have to load the most current environment as well as the module first. You can do that with the command
module load hpc-env/8.3 # as the time of writing (June 2021) this is the most up to date environment module load SAMtools # Without a specified version, this loads the default version, which mostly is just the most current installed module version
Since there are multiple version of SAMtools installed, you can specify your needed version by changing the last part of the "module load"-command, e.g.
module load SAMtools/0.1.19-foss-2019b
would load version 0.1.19 instead of the most current version.
After loading any of the mentioned SAMtools modules, you can call the actual software executable by just typing in:
samtools <argument> <target_file>
If you need some basic help on the softzware syntax, you can call samtools without any arguments to get an overview about the different supported commands.
Documentation
The full documentation can be found here.