comparison biosamples.xml @ 0:dfbc1c40c486 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/beacon2-import commit f4151aa2d760f931f819f954f465ef66055bf258
author iuc
date Mon, 22 Jul 2024 12:34:07 +0000
parents
children 8369c873150a
comparison
equal deleted inserted replaced
-1:000000000000 0:dfbc1c40c486
1 <tool id="beacon2_biosamples" name="Beacon2 Biosamples" version="1.0.0" profile="21.05">
2 <description>Query the biosamples collection in the beacon database for samples taken from individuals</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="creators"/>
7 <expand macro="requirements"/>
8 <command detect_errors="exit_code">
9 <![CDATA[
10 beacon2-search biosamples
11 --db-host '$db_host'
12 --db-port $db_port
13 --database '$database'
14 --collection '$collection'
15 --advance-connection
16 --db-auth-config '$credentials'
17 #if str($advanced_settings.biosampleStatus)
18 --biosampleStatus '$advanced_settings.biosampleStatus'
19 #end if
20 #if str($advanced_settings.collectionDate)
21 --collectionDate '$advanced_settings.collectionDate'
22 #end if
23 #if str($advanced_settings.collectionMoment)
24 --collectionMoment '$advanced_settings.collectionMoment'
25 #end if
26 #if str($advanced_settings.identification)
27 --identification '$advanced_settings.identification'
28 #end if
29 #if str($advanced_settings.diagnosticMarkers)
30 --diagnosticMarkers '$advanced_settings.diagnosticMarkers'
31 #end if
32 #if str($advanced_settings.histologicalDiagnosis)
33 --histologicalDiagnosis '$advanced_settings.histologicalDiagnosis'
34 #end if
35 #if str($advanced_settings.obtentionProcedure)
36 --obtentionProcedure '$advanced_settings.obtentionProcedure'
37 #end if
38 #if str($advanced_settings.pathologicalStage)
39 --pathologicalStage '$advanced_settings.pathologicalStage'
40 #end if
41 #if str($advanced_settings.pathologicalTnmFinding)
42 --pathologicalTnmFinding '$advanced_settings.pathologicalTnmFinding'
43 #end if
44 #if str($advanced_settings.featureType)
45 --featureType '$advanced_settings.featureType'
46 #end if
47 #if str($advanced_settings.severity)
48 --severity '$advanced_settings.severity'
49 #end if
50 #if str($advanced_settings.sampleOriginDetail)
51 --sampleOriginDetail '$advanced_settings.sampleOriginDetail'
52 #end if
53 #if str($advanced_settings.sampleOriginType)
54 --sampleOriginType '$advanced_settings.sampleOriginType'
55 #end if
56 #if str($advanced_settings.sampleProcessing)
57 --sampleProcessing '$advanced_settings.sampleProcessing'
58 #end if
59 #if str($advanced_settings.sampleStorage)
60 --sampleStorage '$advanced_settings.sampleStorage'
61 #end if
62 #if str($advanced_settings.tumorGrade)
63 --tumorGrade '$advanced_settings.tumorGrade'
64 #end if
65 #if str($advanced_settings.tumorProgression)
66 --tumorProgression '$advanced_settings.tumorProgression'
67 #end if
68 > biosamples_query_findings.json
69 ]]>
70 </command>
71 <expand macro="configfile"/>
72 <inputs>
73 <expand macro="Connection_to_MongoDB"/>
74 <expand macro="Database_Configuration"/>
75 <section name="advanced_settings" title="Advanced settings" expanded="false">
76 <param argument="--biosampleStatus" optional="true" type="text" label="BIOSAMPLE STATUS" value="" help="Ontology value for the classification of the sample in abnormal sample (EFO:0009655) or reference sample (EFO:0009654)" />
77 <param argument="--collectionDate" optional="true" type="text" label="COLLECTION DATE" value="" help="Date of biosample collection in ISO8601 format" />
78 <param argument="--collectionMoment" optional="true" type="text" label="COLLECTION MOMENT" value="" help="Individual's or cell culture age at the time of sample collection in the ISO8601 duration format P[n]Y[n]M[n]DT[n]H[n]M[n]S, e.g. P32Y6M1D, P7D" />
79 <param argument="--identification" optional="true" type="text" label="ID" value="" help="Biosample identifier (external accession or internal ID)" />
80 <param argument="--diagnosticMarkers" optional="true" type="text" label="DIAGNOSTIC MARKERS" value="" help="Clinically relevant bio markers, e.g. T2b Stage Finding" />
81 <param argument="--histologicalDiagnosis" optional="true" type="text" label="HISTOLOGICAL DIAGNOSIS" value="" help="Disease diagnosis that was inferred from the histological examination, e.g. Serous Cystadenocarcinoma" />
82 <param argument="--obtentionProcedure" optional="true" type="text" label="OBTENTION PROCEDURE" value="" help="Ontology value describing the procedure for sample obtention, e.g. biopsy" />
83 <param argument="--pathologicalStage" optional="true" type="text" label="PATHOLOGICAL STAGE" value="" help="Pathological stage, if applicable, e.g. Stage IIIA" />
84 <param argument="--pathologicalTnmFinding" optional="true" type="text" label="PATHOLOGICAL TNM FINDING" value="" help="T2b Stage Finding" />
85 <param argument="--featureType" optional="true" type="text" label="FEATURE TYPE" value="" help="Definition of an ontology term which describes the phenotype, e.g. Infantile spasms" />
86 <param argument="--severity" optional="true" type="text" label="SEVERITY" value="" help="Ontology class that describes the severity of the condition, e.g. Moderate" />
87 <param argument="--sampleOriginDetail" optional="true" type="text" label="SAMPLE ORIGIN DETAIL" value="" help="Tissue from which the sample was taken or sample origin matching the category set in 'sampleOriginType', e.g. wall of urinary bladder" />
88 <param argument="--sampleOriginType" optional="true" type="text" label="SAMPLE ORIGIN TYPE" value="" help="Category of sample origin. Value from Ontology for Biomedical Investigations (OBI) material entity, e.g abnormal sample" />
89 <param argument="--sampleProcessing" optional="true" type="text" label="SAMPLE PROCESSING" value="" help="Status of how the specimen was processed, e.g. mechanical dissociation" />
90 <param argument="--sampleStorage" optional="true" type="text" label="SAMPLE STORAGE" value="" help="Status of how the specimen was stored" />
91 <param argument="--tumorGrade" optional="true" type="text" label="TUMOR GRADE" value="" help="Term representing the tumor grade, e.g. Grade 3a" />
92 <param argument="--tumorProgression" optional="true" type="text" label="TUMOR PROGRESSION" value="" help="Tumor progression category indicating primary, metastatic or recurrent progression, e.g. Primary Malignant Neoplasm" />
93 </section>
94 </inputs>
95 <outputs>
96 <data name="out_biosamples_query" format="json" label="${tool.name} on ${on_string}: Biosamples Query" from_work_dir="biosamples_query_findings.json" />
97 </outputs>
98 <tests>
99 <test expect_num_outputs="1">
100 <param name="database" value="beacon" />
101 <param name="collection" value="biosamples" />
102 <param name="db_host" value="20.108.51.167" />
103 <param name="tumorGrade" value="Grade 2 Lesion" />
104 <param name="biosampleStatus" value="abnormal sample" />
105 <param name="collectionDate" value="2021-04-23" />
106 <param name="sampleOriginDetail" value="wall of urinary bladde" />
107 <param name="tumorProgression" value="Primary Malignant Neoplasm" />
108 <output name="out_biosamples_query">
109 <assert_contents>
110 <has_text_matching expression="_id"/>
111 </assert_contents>
112 </output>
113 </test>
114 </tests>
115 <help><![CDATA[
116 Beacon2 Biosamples queries the biosamples collection in the Beacon database for samples taken from individuals. This tool allows detailed queries using advanced settings such as biosample status, collection date, diagnostic markers, and more.
117 ]]></help>
118 <expand macro="citations" />
119 </tool>