Difference between revisions of "Picard"

From UFRC
Jump to navigation Jump to search
(Created page with "__NOTOC__ __NOEDITSECTION__ Category:SoftwareCategory:BioinformaticsCategory:NGS <!-- ######## Template Configuration ######## --> <!--Edit definitions of the variab...")
 
Line 20: Line 20:
 
<!--Choose sections to enable - OPTIONAL-->
 
<!--Choose sections to enable - OPTIONAL-->
 
|{{#vardefine:mod|1}} <!--Present instructions for running the software with modules -->
 
|{{#vardefine:mod|1}} <!--Present instructions for running the software with modules -->
|{{#vardefine:exe|}} <!--Present manual instructions for running the software -->
+
|{{#vardefine:exe|1}} <!--Present manual instructions for running the software -->
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
 
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
 
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
 
|{{#vardefine:pbs|}} <!--Enable PBS script wiki page link-->
Line 46: Line 46:
 
See the [[Samtools|samtools HPC wiki page]] for more details on Samtools.
 
See the [[Samtools|samtools HPC wiki page]] for more details on Samtools.
 
{{#if: {{#var: exe}}|==How To Run==
 
{{#if: {{#var: exe}}|==How To Run==
WRITE INSTRUCTIONS ON RUNNING THE ACTUAL BINARY|}}
+
There is a convenience symlink to the latest picard directory as
 +
/apps/picard/bin
 +
To run picard tools with non-default java memory settings you can set the minimum and the maximum heap memory in the command. For example:
 +
java -Xms1g -Xmx8g -jar /apps/picard/bin/ReorderSam.jar INPUT=input.bam OUTPUT=output.bam VALIDATION_STRINGENCY=LENIENT REFERENCE=.ref.fasta CREATE_INDEX=true
 +
|}}
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
 
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}}
 
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}}

Revision as of 20:58, 31 May 2012

Description

{{{name}}} website  
SAM (Sequence Alignment/Map) format is a generic format for storing large nucleotide sequence alignments. SAM is described in the SAMtools project page.

Picard comprises Java-based command-line utilities that manipulate SAM files, and a Java API (SAM-JDK) for creating new programs that read and write SAM files. Both SAM text format and SAM binary (BAM) format are supported.

Picard does not have its own mailing lists. Please use the SAMTools mailing Lists for Picard-related correspondence. Template:App Location

Available versions

  • 1.54

Running the application using modules

To use picard with the environment modules system at HPC the following commands are available:

Get module information for picard:

$module spider picard

Load the default application module:

$module load picard

The modulefile for this software adds the directory with executable files to the shell execution PATH and sets the following environment variables:

  • HPC_PICARD_DIR - directory where picard is located.

See the samtools HPC wiki page for more details on Samtools.

How To Run

There is a convenience symlink to the latest picard directory as

/apps/picard/bin

To run picard tools with non-default java memory settings you can set the minimum and the maximum heap memory in the command. For example:

java -Xms1g -Xmx8g -jar /apps/picard/bin/ReorderSam.jar INPUT=input.bam OUTPUT=output.bam VALIDATION_STRINGENCY=LENIENT REFERENCE=.ref.fasta CREATE_INDEX=true