diff split_file_to_collection.xml @ 4:0850f2dfba13 draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/split_file_to_collection commit 872590086696cfbc248519507ecb9063926297ad"

--- a/split_file_to_collection.xml	Tue Sep 10 12:31:15 2019 -0400
+++ b/split_file_to_collection.xml	Wed Oct 09 07:34:49 2019 -0400
@@ -1,4 +1,4 @@
-<tool id="split_file_to_collection" name="Split file" version="0.2.0">
+<tool id="split_file_to_collection" name="Split file" version="0.3.0">
     <description>to dataset collection</description>
     <macros>
         <xml name="regex_sanitizer">
@@ -15,7 +15,18 @@
             </sanitizer>
         </xml>
         <xml name="numnew_fname">
-            <param name="numnew" type="integer" label="Number of new files" min="1" value="1"/>
+            <conditional name="select_mode">
+                <param name="mode" type="select" label="Specify number of output files or number of records per file?" help="Specify the number of records ('chunk size') to place in each file. The 'Number of new files' parameter will be ignored.">
+                    <option value="chunk">Number of records per file ('chunk mode')</option>
+                    <option value="numnew">Number of output files</option>
+                </param>
+                <when value="chunk">
+                    <param name="chunksize" type="integer" label="Chunk size" min="1" value="1" help="Number of records per output file."/>
+                </when>
+                <when value="numnew">
+                    <param name="numnew" type="integer" label="Number of new files" min="1" value="1"/>
+                </when>
+            </conditional>
             <param name="newfilenames" type="text" label="Base name for new files in collection"
                 help="This will increment automatically - if input is 'file', then output is 'file0', 'file1', etc." value="split_file"/>
             <conditional name="select_allocate">
@@ -25,7 +36,7 @@
                     <option value="byrow" selected="true">Alternate output files</option>
                 </param>
                 <when value="random">
-                    <param name="seed" type="integer" label="Random number seed" help="For reproducibility, set this to some arbitrary integer (i.e. '1010')" value="1010"/>
+                    <param name="seed" type="integer" label="Random number seed" help="For reproducibility, set this to some arbitrary integer (e.g. '1010')" value="1010"/>
                 </when>
                 <when value="batch">
                 </when>
@@ -51,7 +62,11 @@
                     --match '$split_parms.split_by.match_regex'
                     --sub '$split_parms.split_by.sub_regex'
                 #else
-                    --numnew '$split_parms.split_by.numnew'
+                    #if $split_parms.split_by.select_mode.mode == "numnew":
+                        --numnew '$split_parms.split_by.select_mode.numnew'
+                    #else
+                        --chunksize $split_parms.split_by.select_mode.chunksize
+                    #end if
                     #if $split_parms.split_by.select_allocate.allocate == "random":
                         --rand
                         --seed '$split_parms.split_by.rand.seed'
@@ -63,8 +78,15 @@
             #else
                 #if $split_parms.select_ftype == "generic"
                     --generic_re '$split_parms.generic_regex'
+                    #if $split_parms.split_after == 'true':
+                        --split_after
+                    #end if
                 #end if
-                --numnew '$split_parms.numnew'
+                #if $split_parms.select_mode.mode == "numnew":
+                    --numnew '$split_parms.select_mode.numnew'
+                #else
+                    --chunksize $split_parms.select_mode.chunksize
+                #end if
                 #if $split_parms.select_allocate.allocate == "random":
                     --rand
                     --seed '$split_parms.select_allocate.seed'
@@ -93,6 +115,7 @@
                 <option value="fastq">FASTQ</option>
                 <option value="tabular">Tabular</option>
                 <option value="fasta">FASTA</option>
+                <option value="sdf">SD-files</option>
                 <option value="txt">Text files</option>
                 <option value="generic">Generic</option>
             </param>
@@ -130,6 +153,10 @@
                 <param name="input" type="data" format="fasta" label="FASTA file to split"/>
                 <expand macro="numnew_fname"/>
             </when>
+            <when value="sdf">
+                <param name="input" type="data" format="sdf" label="SD-file to split"/>
+                <expand macro="numnew_fname"/>
+            </when>
             <when value="txt">
                 <param name="input" type="data" format="txt" label="Text file to split"/>
                 <expand macro="numnew_fname"/>
@@ -140,6 +167,10 @@
                     <expand macro="regex_sanitizer"/>
                 </param>
                 <expand macro="numnew_fname"/>
+                <param name="split_after" type="select" value="false" label="Split records before or after the separator?" help="If before, the separator will appear at the start of each record; if after, at the end">
+                    <option value="false" selected="true">Before</option>
+                    <option value="true">After</option>
+                </param>
             </when>
         </conditional>
     </inputs>
@@ -160,6 +191,10 @@
             <discover_datasets pattern="__name__" directory="out" visible="false" format="fastq"/>
             <filter>split_parms['select_ftype'] == "fastq"</filter>
         </collection>
+        <collection name="list_output_sdf" type="list" label="${tool.name} on ${on_string}">
+            <discover_datasets pattern="__name__" directory="out" visible="false" format="sdf"/>
+            <filter>split_parms['select_ftype'] == "sdf"</filter>
+        </collection>
         <collection name="list_output_txt" type="list" label="${tool.name} on ${on_string}">
             <discover_datasets pattern="__name__" directory="out" visible="false" format="txt"/>
             <filter>split_parms['select_ftype'] == "txt"</filter>
@@ -189,6 +224,7 @@
             <param name="select_ftype" value="tabular"/>
             <param name="select_split_by" value="row"/>
             <param name="top" value="2"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="test"/>
             <output_collection name="list_output_tab" type="list">
@@ -201,6 +237,7 @@
             <param name="select_ftype" value="tabular"/>
             <param name="select_split_by" value="row"/>
             <param name="top" value="2"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="batch_tab"/>
             <param name="allocate" value="batch"/>
@@ -210,8 +247,23 @@
             </output_collection>
         </test>
         <test>
+            <param name="input" value="test.tabular" ftype="tabular"/>
+            <param name="select_ftype" value="tabular"/>
+            <param name="select_split_by" value="row"/>
+            <param name="top" value="2"/>
+            <param name="mode" value="chunk"/>
+            <param name="chunksize" value="2"/>
+            <param name="newfilenames" value="batch_tab"/>
+            <param name="allocate" value="batch"/>
+            <output_collection name="list_output_tab" type="list">
+                <element name="batch_tab_000000.tabular" file="batch_tab_0.tabular" ftype="tabular"/>
+                <element name="batch_tab_000001.tabular" file="batch_tab_1.tabular" ftype="tabular"/>
+            </output_collection>
+        </test>
+        <test>
             <param name="select_ftype" value="txt"/>
             <param name="input" value="karyotype.txt" ftype="txt"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="24"/>
             <param name="newfilenames" value="chr"/>
             <param name="allocate" value="batch"/>
@@ -261,6 +313,7 @@
         <test>
             <param name="input" value="demo758Dacentroid.mgf" ftype="mgf"/>
             <param name="select_ftype" value="mgf"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="3"/>
             <param name="newfilenames" value="demo"/>
             <output_collection name="list_output_mgf" type="list">
@@ -272,6 +325,7 @@
         <test>
             <param name="input" value="test.fasta" ftype="fasta"/>
             <param name="select_ftype" value="fasta"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="test"/>
             <output_collection name="list_output_fasta" type="list">
@@ -280,8 +334,20 @@
             </output_collection>
         </test>
         <test>
+            <param name="input" value="test.fasta" ftype="fasta"/>
+            <param name="select_ftype" value="fasta"/>
+            <param name="mode" value="chunk"/>
+            <param name="chunksize" value="3"/>
+            <param name="newfilenames" value="test"/>
+            <output_collection name="list_output_fasta" type="list">
+                <element name="test_000000.fasta" file="test_0.fasta" ftype="fasta"/>
+                <element name="test_000001.fasta" file="test_1.fasta" ftype="fasta"/>
+            </output_collection>
+        </test>
+        <test>
             <param name="input" value="test.fastq" ftype="fastq"/>
             <param name="select_ftype" value="fastq"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="test"/>
             <output_collection name="list_output_fastq" type="list">
@@ -292,6 +358,7 @@
         <test>
             <param name="input" value="test.fasta" ftype="fasta"/>
             <param name="select_ftype" value="fasta"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="rand"/>
             <param name="allocate" value="random"/>
@@ -304,6 +371,7 @@
         <test>
             <param name="input" value="test.fasta" ftype="fasta"/>
             <param name="select_ftype" value="fasta"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="fasta_batch"/>
             <param name="allocate" value="batch"/>
@@ -315,6 +383,7 @@
         <test>
             <param name="input" value="test.tabular" ftype="txt"/>
             <param name="select_ftype" value="txt"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="test"/>
             <output_collection name="list_output_txt" type="list">
@@ -326,6 +395,7 @@
             <param name="input" value="test.tabular" ftype="txt"/>
             <param name="select_ftype" value="generic"/>
             <param name="generic_regex" value="^.*"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="test"/>
             <output_collection name="list_output_generic" type="list">
@@ -337,6 +407,7 @@
             <param name="input" value="test.fasta" ftype="fasta"/>
             <param name="select_ftype" value="generic"/>
             <param name="generic_regex" value="^>.*"/>
+            <param name="mode" value="numnew"/>
             <param name="numnew" value="2"/>
             <param name="newfilenames" value="rand"/>
             <param name="allocate" value="random"/>
@@ -348,29 +419,59 @@
         </test>
         <test>
             <param name="input" value="3_molecules.sdf" ftype="sdf"/>
-            <param name="select_ftype" value="generic"/>
-            <param name="generic_regex" value="^\$\$\$\$.*"/>
-            <param name="numnew" value="1000"/>
+            <param name="select_ftype" value="sdf"/>
+            <param name="mode" value="numnew"/>
+            <param name="numnew" value="10"/>
+            <param name="newfilenames" value="mol"/>
+            <param name="allocate" value="batch"/>
+            <output_collection name="list_output_sdf" type="list">
+                <element name="mol_000000.sdf" file="mol_0.sdf" ftype="sdf"/>
+                <element name="mol_000001.sdf" file="mol_1.sdf" ftype="sdf"/>
+                <element name="mol_000002.sdf" file="mol_2.sdf" ftype="sdf"/>
+            </output_collection>
+        </test>
+        <test>
+            <param name="input" value="3_molecules.sdf" ftype="sdf"/>
+            <param name="select_ftype" value="sdf"/>
+            <param name="mode" value="chunk"/>
+            <param name="chunksize" value="1"/>
             <param name="newfilenames" value="mol"/>
             <param name="allocate" value="batch"/>
+            <output_collection name="list_output_sdf" type="list">
+                <element name="mol_000000.sdf" file="mol_0.sdf" ftype="sdf"/>
+                <element name="mol_000001.sdf" file="mol_1.sdf" ftype="sdf"/>
+                <element name="mol_000002.sdf" file="mol_2.sdf" ftype="sdf"/>
+            </output_collection>
+        </test>
+        <test>
+            <param name="input" value="test.fasta" ftype="fasta"/>
+            <param name="select_ftype" value="generic"/>
+            <param name="generic_regex" value="^>.*"/>
+            <param name="split_after" value="true"/>
+            <param name="mode" value="numnew"/>
+            <param name="numnew" value="2"/>
+            <param name="newfilenames" value="rand"/>
+            <param name="allocate" value="random"/>
+            <param name="seed" value="1010"/>
             <output_collection name="list_output_generic" type="list">
-                <element name="mol_000000" file="mol_0.sdf" ftype="sdf"/>
-                <element name="mol_000001" file="mol_1.sdf" ftype="sdf"/>
-                <element name="mol_000002" file="mol_2.sdf" ftype="sdf"/>
+                <element name="rand_000001" file="split_after.fasta" ftype="fasta"/>
             </output_collection>
         </test>
     </tests>
     <help><![CDATA[
 **Split file into a dataset collection**
 
-This tool splits a data sets consisting of records into multiple data sets within a collection.
+This tool splits a data set consisting of records into multiple data sets within a collection.
 A record can be for instance simply a line, a FASTA sequence (header + sequence), a FASTQ sequence
-(headers + sequence + qualities), etc. The important property is that the begin of a new record
-can be speciefied by a regular expression, e.g. ".*" for lines, ">.*" for FASTA, or "@.*" for FASTQ.
-The tool has presets for text, tabular data sets (which are split by line), FASTA, FASTQ, and MGF.
-For other data types the text delimiting records can be specified manually using the generic splitter.
+(headers + sequence + qualities), etc. The important property is that the beginning of a new record
+can be specified by a regular expression, e.g. ".*" for lines, ">.*" for FASTA, or "@.*" for FASTQ.
+The tool has presets for text, tabular data sets (which are split by line), FASTA, FASTQ, SDF and MGF.
+For other data types the text delimiting records can be specified manually using the generic splitter. 
+If the generic splitter is used, an option is also available to split records either before or after the
+separator. If a preset filetype is used, this is selected automatically (after for SDF, before for all
+others).
 
-If splitting by line (or by some other item, like a FASTA entry or an MGF record, the splitting can be either done alternating, in original record order, or at random.
+If splitting by line (or by some other item, like a FASTA entry or an MGF record), the splitting can be either done alternatingly, in original record order, or at random.
 
 If t records are to be distributed to n new data sets, then the i-th record goes to data set
 
@@ -407,13 +508,16 @@
 If a tabular file is used as input, you may choose to split by line or by column. If split by column, a new file is created for each unique value in the column.
 In addition, (Python) regular expressions may be used to transform the value in the column to a new value. Caution should be used with this feature, as it could transform all values to the same value, or other unexpected behavior.
 The default regular expression uses each value in the column without modifying it.
+
+Two modes are available for the tool. For the main mode, the number of output files is selected. In this case, records are shared out between this number of files. Alternatively, 'chunking mode' can be selected, which puts a fixed number of records (the 'chunk size') into each output file.
+
     ]]></help>
     <citations>
         <citation type="bibtex">
 @misc{githubsplit,
   author = {Easterly, Caleb},
   year = {2018},
-  title = {A Galxy tool for splitting a file into a collection},
+  title = {A Galaxy tool for splitting a file into a collection},
   publisher = {GitHub},
   journal = {GitHub repository},
   url = {https://github.com/bgruening/galaxytools/tools/text_processing/split_file_to_collection},