Difference between revisions of "HTSeq"

From UFRC
Jump to navigation Jump to search
m (Text replace - "{{App_Description|app={{#var:app}}|url={{#var:url}}}}|}}" to "{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}} ")
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
__NOEDITSECTION__
 
__NOEDITSECTION__
[[Category:Software]][[Category:Bioinformatics]][[Category:NGS]]
+
[[Category:Software]][[Category:Biology]][[Category:NGS]]
<!-- ########  Template Configuration ######## -->
+
{|<!--Main settings - REQUIRED-->
<!--Edit definitions of the variables used in template calls
 
Required variables:
 
app - lowercase name of the application e.g. "amber"
 
url - url of the software page (project, company product, etc) - e.g. "http://ambermd.org/"
 
Optional variables:
 
INTEL - Version of the Intel Compiler e.g. "11.1"
 
MPI - MPI Implementation and version e.g. "openmpi/1.3.4"
 
-->
 
{|
 
<!--Main settings - REQUIRED-->
 
 
|{{#vardefine:app|htseq}}
 
|{{#vardefine:app|htseq}}
 
|{{#vardefine:url|http://www-huber.embl.de/users/anders/HTSeq/doc/overview.html}}
 
|{{#vardefine:url|http://www-huber.embl.de/users/anders/HTSeq/doc/overview.html}}
<!--Compiler and MPI settings - OPTIONAL -->
 
|{{#vardefine:intel|}} <!-- E.g. "11.1" -->
 
|{{#vardefine:mpi|}} <!-- E.g. "openmpi/1.3.4" -->
 
<!--Choose sections to enable - OPTIONAL-->
 
|{{#vardefine:mod|1}} <!--Present instructions for running the software with modules -->
 
 
|{{#vardefine:exe|1}} <!--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-->
Line 26: Line 11:
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
 
|{{#vardefine:faq|}} <!--Enable FAQ section -->
 
|{{#vardefine:faq|}} <!--Enable FAQ section -->
|{{#vardefine:citation|}} <!--Enable Reference/Citation section -->
+
|{{#vardefine:citation|1}} <!--Enable Reference/Citation section -->
 
|}
 
|}
 
<!-- ########  Template Body ######## -->
 
<!-- ########  Template Body ######## -->
Line 38: Line 23:
  
 
While the main purpose of HTSeq is to allow you to write your own analysis scripts, customized to your needs, there are also a couple of stand-alone scripts for common tasks that can be used without any Python knowledge. See the Scripts section in the overview below for what is available.
 
While the main purpose of HTSeq is to allow you to write your own analysis scripts, customized to your needs, there are also a couple of stand-alone scripts for common tasks that can be used without any Python knowledge. See the Scripts section in the overview below for what is available.
 
+
<!--Modules-->
<!--Location-->
+
==Environment Modules==
==Available versions==
+
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
* 0.5.3p3 (both EL5 and EL6).
+
==System Variables==
 
+
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
''Note: HTSeq has been installed into and its module loads python/2.6.5 on EL5 and python/2.7.3 on EL6. In addition, matplotlib has been installed for htseq-qa to work.''
 
<!-- -->
 
{{#if: {{#var: mod}}|==Running the application using modules==
 
{{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}}
 
 
* HPC_HTSEQ_BIN - executable directory.
 
* HPC_HTSEQ_BIN - executable directory.
{{#if: {{#var: exe}}|==How To Run==
+
<!--Additional-->
 +
{{#if: {{#var: exe}}|==Additional Information==
 
Two programs are available - htseq-count and htseq-qa. Run them without any arguments to see the usage information. The main HTSeq module can be loaded from python (import HTSeq). See HTSeq documentation for a tutorial.
 
Two programs are available - htseq-count and htseq-qa. Run them without any arguments to see the usage information. The main HTSeq module can be loaded from python (import HTSeq). See HTSeq documentation for a tutorial.
 
|}}
 
|}}
Line 55: Line 37:
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
{{#if: {{#var: pbs}}|==PBS Script Examples==
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
 
See the [[{{PAGENAME}}_PBS]] page for {{#var: app}} PBS script examples.|}}
{{#if: {{#var: policy}}|==Usage policy==
+
{{#if: {{#var: policy}}|==Usage Policy==
 
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
 
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
 
{{#if: {{#var: testing}}|==Performance==
 
{{#if: {{#var: testing}}|==Performance==
Line 63: Line 45:
 
{{#if: {{#var: citation}}|==Citation==
 
{{#if: {{#var: citation}}|==Citation==
 
If you publish research that uses {{{app}}} you have to cite it as follows:
 
If you publish research that uses {{{app}}} you have to cite it as follows:
WRITE CITATION HERE
+
 
 +
Simon Anders, Paul Theodor Pyl, Wolfgang Huber
 +
HTSeq — A Python framework to work with high-throughput sequencing data
 +
Bioinformatics (2014), in print, online at [http://doi:10.1093/bioinformatics/btu638 doi:10.1093/bioinformatics/btu638].
 
|}}
 
|}}

Latest revision as of 19:05, 12 August 2022

Description

htseq website  

HTSeq is a Python package that provides infrastructure to process data from high-throughput sequencing assays.

See the HTSeq documentation chapter A tour through HTSeq first for an overview on the kind of analysis you can do with HTSeq and the design of the package, and then look at the reference documentation.

While the main purpose of HTSeq is to allow you to write your own analysis scripts, customized to your needs, there are also a couple of stand-alone scripts for common tasks that can be used without any Python knowledge. See the Scripts section in the overview below for what is available.

Environment Modules

Run module spider htseq to find out what environment modules are available for this application.

System Variables

  • HPC_HTSEQ_DIR - installation directory
  • HPC_HTSEQ_BIN - executable directory.

Additional Information

Two programs are available - htseq-count and htseq-qa. Run them without any arguments to see the usage information. The main HTSeq module can be loaded from python (import HTSeq). See HTSeq documentation for a tutorial.



Citation

If you publish research that uses {{{app}}} you have to cite it as follows:

Simon Anders, Paul Theodor Pyl, Wolfgang Huber HTSeq — A Python framework to work with high-throughput sequencing data Bioinformatics (2014), in print, online at doi:10.1093/bioinformatics/btu638.