annotate cherri_eval.xml @ 2:5cc3b0e3178e draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit 8778c3f71e295ec5b62ef3998319d211fc864e35
author iuc
date Wed, 25 Jan 2023 18:32:58 +0000
parents 875ba3871f3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
1 <tool id="cherri_eval" name="Evaluation of RRIs using CheRRI" version="@VERSION@" profile="@PROFILE@">
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
2 <macros>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
3 <import>macros.xml</import>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
4 </macros>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
5 <expand macro="requirements"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
7 export PYTHONHASHSEED=31337 &&
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
8 ln -s '$ref_source.genome_fasta' genome.fa &&
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
9 mkdir model_dir &&
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
10 tar -C model_dir -xvf '$model_tar' > /dev/null &&
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
11 cherri eval
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
12 -i1 '$rris_table'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
13 -g genome.fa
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
14 -l '$chrom_len_file'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
15 -o .
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
16 -on cherri_eval
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
17 -c '$context'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
18 -st $use_structure
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
19 -hf $hand_feat
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
20 -m 'model_dir/final_full.model'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
21 -mp 'model_dir/features.npz'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
22 #if $occupied_regions:
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
23 -i2 '$occupied_regions'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
24 #end if
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
25 #if $intarna_param_file:
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
26 -p '$intarna_param_file'
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
27 #end if
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
28 ]]></command>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
29 <inputs>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
30 <param name="rris_table" type="data" format="csv" label="CSV file containing all RRIs that should be evaluated" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
31 <expand macro="reference_source_conditional"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
32 <param name="model_tar" type="data" format="tgz" label="Model and feature files in a tar" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
33 <param name="context" type="integer" value="150" label="How much context should be added at up- and downstream of each sequence" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
34 <param name="use_structure" type="boolean" truevalue="on" falsevalue="off" checked="true" label="Set 'off' if you want to disable structure, default 'on'" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
35 <param name="hand_feat" type="boolean" truevalue="on" falsevalue="off" checked="false" label="If you want to start from hand-curated feature files, use this for evaluating test set performance. Default: 'off'" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
36 <param name="occupied_regions" optional="True" type="data" format="binary" label="Occupied regions python object file containing a dictionary" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
37 <param name="intarna_param_file" optional="True" type="data" format="txt" label="IntaRNA parameters file" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
38 </inputs>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
39 <outputs>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
40 <data name="eval_out" format="csv" from_work_dir="cherri_eval/evaluation/evaluation_results_eval_rri.csv" label="Evaluation results on ${on_string}"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
41 </outputs>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
42 <tests>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
43 <test>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
44 <param name="rris_table" value="test_evaluate_rris.csv"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
45 <conditional name="ref_source">
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
46 <param name="ref_source_selector" value="history"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
47 <param name="genome_fasta" value="genome.fa"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
48 </conditional>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
49 <param name="chrom_len_file" value="genome.sizes" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
50 <param name="model_tar" value="context_150_model.tgz" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
51 <output name="eval_out" file="evaluation_results_st_on.csv"/>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
52 </test>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
53 </tests>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
54 <help><![CDATA[
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
55
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
56 **What it does**
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
57
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
58 CheRRI detects functional RNA-RNA interaction (RRI) sites, by evaluating if an interaction site most likely occurs in nature. It helps to filter interaction sites generated either experimentally or by an RRI prediction algorithm, by removing false positive interactions.
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
59
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
60 **Inputs**
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
61
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
62 CheRRI takes a table of RNA-RNA interactions. It supports output of ChiRA or a csv files of interactions in the following format. The table needs the following header line:
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
63
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
64 `chrom1,start1,stop1,strand1,chrom2,start2,stop2,strand2`
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
65
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
66 Following the header line, each subsequent line represents an RRI, with chromosome ID (format: 1,2,3 ...), interaction start, interaction end, and strand ("+" or "-") of the two interacting partners. For example, you might want to evaluate the following three RRI sites::
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
67
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
68 19,18307518,18307539,-,14,90454500,90454521,+
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
69 X,109054541,109054590,+,9,89178539,89178562,-
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
70 10,123136102,123136122,+,5,1245880,1245902,+
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
71
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
72 The tool also additionally takes a genome FASTA file and a chromosome lengths file. User can select an in-built FASTA or a FASTA file from history.
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
73 A chromosome legths file is tabular file where each line contains a tab separated chromosome name and its length. Followin is an example:
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
74
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
75 chr1 23200231
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
76 chr2 12497572
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
77 chr3 8387920
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
78
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
79 CheRRI also needs a model file (in binary format). It can be generated by using CheRRI train tool.
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
80
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
81 **Outputs**
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
82
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
83 This tool outputs a tabular file containing predictions for each input interaction.
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
84
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
85 ]]></help>
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
86 <expand macro="citations" />
875ba3871f3c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/cherri commit f9348123725f421ddbdbd8d372d038da4880dbac
iuc
parents:
diff changeset
87 </tool>