comparison complete_immunerepertoire.xml @ 18:5d11c9139a55 draft

Uploaded

17:da95be204ebc

	"custom" "${gene_selection.vgenes};${gene_selection.dgenes};${gene_selection.jgenes}" $filterproductive $clonality_method
#end if
	</command>
	<inputs>
		<repeat name="patients" title="Donor" min="1" default="1">
			<repeat name="samples" title="Sample" min="1" default="1">
					<param name="sample" type="data" label="Sample to Process" />
			</repeat>
			<param name="id" type="text" label="ID" />
		</repeat>
		<param name="clonaltype" type="select" label="Clonal Type Definition">
			<option value="none">Don't remove duplicates based on clonaltype</option>

		<requirement type="package" version="0.6">igblastwrp</requirement>
		<requirement type="package" version="3.3">weblogo</requirement>
		<!--<requirement type="package" version="0.20">circostools</requirement>-->
	</requirements>
	<help>
		The entire Immune Repertoire pipeline as a single tool, input several FASTA files or IMGT zip/txz files, give them an ID and it will BLAST/parse, merge and plot them.

		.. class:: warningmark

Custom gene ordering based on position on genome: 

**Human**

IGH::

    V:
    IGHV7-81,IGHV3-74,IGHV3-73,IGHV3-72,IGHV3-71,IGHV2-70,IGHV1-69,IGHV3-66,IGHV3-64,IGHV4-61,IGHV4-59,IGHV1-58,IGHV3-53,IGHV3-52,IGHV5-a,IGHV5-51,IGHV3-49,IGHV3-48,IGHV3-47,IGHV1-46,IGHV1-45,IGHV3-43,IGHV4-39,IGHV3-35,IGHV4-34,IGHV3-33,IGHV4-31,IGHV4-30-4,IGHV4-30-2,IGHV3-30-3,IGHV3-30,IGHV4-28,IGHV2-26,IGHV1-24,IGHV3-23,IGHV3-22,IGHV3-21,IGHV3-20,IGHV3-19,IGHV1-18,IGHV3-15,IGHV3-13,IGHV3-11,IGHV3-9,IGHV1-8,IGHV3-7,IGHV2-5,IGHV7-4-1,IGHV4-4,IGHV4-b,IGHV1-3,IGHV1-2,IGHV6-1
    D:
    IGHD1-1,IGHD2-2,IGHD3-3,IGHD6-6,IGHD1-7,IGHD2-8,IGHD3-9,IGHD3-10,IGHD4-11,IGHD5-12,IGHD6-13,IGHD1-14,IGHD2-15,IGHD3-16,IGHD4-17,IGHD5-18,IGHD6-19,IGHD1-20,IGHD2-21,IGHD3-22,IGHD4-23,IGHD5-24,IGHD6-25,IGHD1-26,IGHD7-27
    J:
    IGHJ1,IGHJ2,IGHJ3,IGHJ4,IGHJ5,IGHJ6


IGK::

    V:
    IGKV3D-7,IGKV1D-8,IGKV1D-43,IGKV3D-11,IGKV1D-12,IGKV1D-13,IGKV3D-15,IGKV1D-16,IGKV1D-17,IGKV3D-20,IGKV2D-26,IGKV2D-28,IGKV2D-29,IGKV2D-30,IGKV1D-33,IGKV1D-39,IGKV2D-40,IGKV2-40,IGKV1-39,IGKV1-33,IGKV2-30,IGKV2-29,IGKV2-28,IGKV1-27,IGKV2-24,IGKV3-20,IGKV1-17,IGKV1-16,IGKV3-15,IGKV1-13,IGKV1-12,IGKV3-11,IGKV1-9,IGKV1-8,IGKV1-6,IGKV1-5,IGKV5-2,IGKV4-1
    J:
    IGKJ1,IGKJ2,IGKJ3,IGKJ4,IGKJ5


IGL::

    V:
    IGLV4-69,IGLV8-61,IGLV4-60,IGLV6-57,IGLV5-52,IGLV1-51,IGLV9-49,IGLV1-47,IGLV7-46,IGLV5-45,IGLV1-44,IGLV7-43,IGLV1-41,IGLV1-40,IGLV5-39,IGLV5-37,IGLV1-36,IGLV3-27,IGLV3-25,IGLV2-23,IGLV3-22,IGLV3-21,IGLV3-19,IGLV2-18,IGLV3-16,IGLV2-14,IGLV3-12,IGLV2-11,IGLV3-10,IGLV3-9,IGLV2-8,IGLV4-3,IGLV3-1
    J:
    IGLJ1,IGLJ2,IGLJ3,IGLJ6,IGLJ7


TRB::

    V:
    TRBV2,TRBV3-1,TRBV4-1,TRBV5-1,TRBV6-1,TRBV4-2,TRBV6-2,TRBV4-3,TRBV6-3,TRBV7-2,TRBV6-4,TRBV7-3,TRBV9,TRBV10-1,TRBV11-1,TRBV10-2,TRBV11-2,TRBV6-5,TRBV7-4,TRBV5-4,TRBV6-6,TRBV5-5,TRBV7-6,TRBV5-6,TRBV6-8,TRBV7-7,TRBV6-9,TRBV7-8,TRBV5-8,TRBV7-9,TRBV13,TRBV10-3,TRBV11-3,TRBV12-3,TRBV12-4,TRBV12-5,TRBV14,TRBV15,TRBV16,TRBV18,TRBV19,TRBV20-1,TRBV24-1,TRBV25-1,TRBV27,TRBV28,TRBV29-1,TRBV30
    D:
    TRBD1,TRBD2
    J:
    TRBJ1-1,TRBJ1-2,TRBJ1-3,TRBJ1-4,TRBJ1-5,TRBJ1-6,TRBJ2-1,TRBJ2-2,TRBJ2-3,TRBJ2-4,TRBJ2-5,TRBJ2-6,TRBJ2-7


TRA::

    V:
    TRAV1-1,TRAV1-2,TRAV2,TRAV3,TRAV4,TRAV5,TRAV6,TRAV7,TRAV8-1,TRAV9-1,TRAV10,TRAV12-1,TRAV8-2,TRAV8-3,TRAV13-1,TRAV12-2,TRAV8-4,TRAV13-2,TRAV14/DV4,TRAV9-2,TRAV12-3,TRAV8-6,TRAV16,TRAV17,TRAV18,TRAV19,TRAV20,TRAV21,TRAV22,TRAV23/DV6,TRAV24,TRAV25,TRAV26-1,TRAV27,TRAV29/DV5,TRAV30,TRAV26-2,TRAV34,TRAV35,TRAV36/DV7,TRAV38-1,TRAV38-2/DV8,TRAV39,TRAV40,TRAV41
    J:
    TRAJ57,TRAJ56,TRAJ54,TRAJ53,TRAJ52,TRAJ50,TRAJ49,TRAJ48,TRAJ47,TRAJ46,TRAJ45,TRAJ44,TRAJ43,TRAJ42,TRAJ41,TRAJ40,TRAJ39,TRAJ38,TRAJ37,TRAJ36,TRAJ34,TRAJ33,TRAJ32,TRAJ31,TRAJ30,TRAJ29,TRAJ28,TRAJ27,TRAJ26,TRAJ24,TRAJ23,TRAJ22,TRAJ21,TRAJ20,TRAJ18,TRAJ17,TRAJ16,TRAJ15,TRAJ14,TRAJ13,TRAJ12,TRAJ11,TRAJ10,TRAJ9,TRAJ8,TRAJ7,TRAJ6,TRAJ5,TRAJ4,TRAJ3


TRG::

    V:
    TRGV9,TRGV8,TRGV5,TRGV4,TRGV3,TRGV2
    J:
    TRGJ2,TRGJP2,TRGJ1,TRGJP1


TRD::

    V:
    TRDV1,TRDV2,TRDV3
    D:
    TRDD1,TRDD2,TRDD3
    J:
    TRDJ1,TRDJ4,TRDJ2,TRDJ3


**Mouse**

TRB::

    V:
    TRBV1,TRBV2,TRBV3,TRBV4,TRBV5,TRBV12-1,TRBV13-1,TRBV12-2,TRBV13-2,TRBV13-3,TRBV14,TRBV15,TRBV16,TRBV17,TRBV19,TRBV20,TRBV23,TRBV24,TRBV26,TRBV29,TRBV30,TRBV31
    D:
    TRBD1,TRBD2
    J:
    TRBJ1-1,TRBJ1-2,TRBJ1-3,TRBJ1-4,TRBJ1-5,TRBJ2-1,TRBJ2-2,TRBJ2-3,TRBJ2-4,TRBJ2-5,TRBJ2-6,TRBJ2-7
    
	</help>

</tool>

18:5d11c9139a55

	"custom" "${gene_selection.vgenes};${gene_selection.dgenes};${gene_selection.jgenes}" $filterproductive $clonality_method
#end if
	</command>
	<inputs>
		<repeat name="patients" title="Donor" min="1" default="1">
			<repeat name="samples" title="Replicate" min="1" default="1">
					<param name="sample" type="data" label="Replicate to Process" />
			</repeat>
			<param name="id" type="text" label="ID" />
		</repeat>
		<param name="clonaltype" type="select" label="Clonal Type Definition">
			<option value="none">Don't remove duplicates based on clonaltype</option>

		<requirement type="package" version="0.6">igblastwrp</requirement>
		<requirement type="package" version="3.3">weblogo</requirement>
		<!--<requirement type="package" version="0.20">circostools</requirement>-->
	</requirements>
	<help>
<![CDATA[
**References**

Boyd SD, Marshall EL, Merker JD, Maniar JM, Zhang LN, Sahaf B, Jones CD, Simen BB, Hanczaruk B, Nguyen KD, Nadeau KC, Egholm M, Miklos DB, Zehnder JL, Fire AZ (2009). Measurement and clinical monitoring of human lymphocyte clonality by massively parallel VDJ pyrosequencing. In *Science Translational Medicine 1(12):12ra23*. 

-----

**Input files**

IMGT/HighV-QUEST .zip and .txz files and FASTA files are accepted as input files. In addition filtered IMGT files generated using the SHM &amp; CSR pipeline can be used as input files. 
Note: Files can be uploaded by using “get data” and “upload file”. When uploading IMGT files  “IMGT archive“ should be selected as a file type. When uploading FASTA files the auto-detect function can be used to select a file type. Special characters should be prevented in the file names of the uploaded samples as these can give errors when running the immune repertoire pipeline. Underscores are allowed in the file names.

-----

**Donor and replicates**

The immune repertoire pipeline can analyse files from multiple donors in parallel. Therefore for each analysed donor an ID has to be given. This ID can only contain letters, numbers and _. Spaces in the ID give an error when running the immune repertoire pipeline. In the default setting of the immune repertoire pipeline one donor consisting out of one sample can be uploaded. However, multiple samples per donor can be uploaded by using the insert sample button. In addition, multiple donors van be added by using the insert donor button. The multiple sample option can be used when multiple data files from the same donor are available. For the calculation of the clonality score using the algorithm described by Boyd et al (PMID: 20161664) at least 3 samples have to be included per donor. 

-----

**Clonal Type Definition**

Allows the selection of a single sequence per clone. Different definitions of a clone can be chosen. 

.. class:: infomark

Note: The first sequence (in the data set) of each clone is always included in the analysis. This means that altering the data order (by for instance sorting) can change the sequence which is included in the analysis and therefore slightly influence results. 

-----

**Order of V(D)J genes in graphs**

This setting allows you to order the V(D)J genes in the graphs in a user defined order. When using the default “IMGT-DB” all genes in the V, D an J gene graphs will be ordered based on their IMGT numbering. By selecting user defined the order of the V, D and J genes in the graphs can be altered according to the users personal settings. For simplifying of visualizing the genes in the chromosomal order the order of V, D and J genes on the chromosome in are included at the bottom of this help page. For any other ordering please provide the order of gene names divided by commas. 

-----

**Species**

Enter the species of the sample you would like to analyse.

-----

**Locus**

A dropdown menu to select the immune receptor locus to be analysed.

-----

**Remove unproductive sequences from graphs**

This filter provides the option to only include productive sequences or both productive and unproductive sequences in the graphs.

-----

**Shared clonal types / clonality**

This filter allows you do identify overlapping sequences between different replicates. If you only upload a single replicate from a sample no sequences overlap or clonality can be determined and therefore the “do not determine overlap” option should be selection. The “Determine the number of sequences that share the same clonal type between the replicates” option allows the user to determine the number of overlapping sequences (based on the clonal type definition defined in the ‘clonal type definition filter’) between different replicates. This can be used to for instance look at different time point in the same donor to changes in the repertoire. When three or more replicates of the same blood same are amplified and sequences in parallel, the “determine clonality of the donor” function can be used to calculate the number of overlapping sequences as well as the clonality score as described by Boyd et al, PMID: 20161664.

-----

**Execute**

Upon pressing the execute button a new analysis is added to your history (right side of the page). Initially this analysis will be grey, after initiating the analysis colour of the analysis in the history will change to yellow. When the analysis is finished it will turn green in the history. Now the analysis can be opened by clicking on the eye icon on the analysis of interest. When an analysis turns red an error has occurred when running the analysis. If you click on the analysis title additional information can be found on the analysis. In addition a bug icon appears. Here more information on the error can be found.
]]>
	</help>

</tool>