diff get_DB_data.xml @ 10:703fda6c48c5 draft

planemo upload for repository https://github.com/brsynth commit 6ae809b563b40bcdb6be2e74fe2a84ddad5484ae
author tduigou
date Fri, 23 May 2025 08:39:47 +0000
parents 6401a277ee72
children 6c1e564bb278
line wrap: on
line diff
--- a/get_DB_data.xml	Fri Apr 18 13:36:40 2025 +0000
+++ b/get_DB_data.xml	Fri May 23 08:39:47 2025 +0000
@@ -1,5 +1,5 @@
 <tool id="get_DB_data" name="get data from DB" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09">
-    <description>Import data from Sorbonne Biofondry DB</description>
+    <description>Import GenBank data from a PostgreSQL database running in a Docker container and export it as .gb files</description>
     <macros>
         <token name="@VERSION_SUFFIX@">0</token>
         <token name="@TOOL_VERSION@">0.1.0</token>
@@ -22,12 +22,12 @@
             --output 'outdir'
     ]]></command>
     <inputs> 
-        <param name="input" type="data" format="csv" label="Input CSV file" />
-        <param name="table" type="text" label="Database Table Name" optional="false" />
-        <param name="sequence_column" type="text" label="DB column contains sequence for ganbank file" optional="false" />
-        <param name="annotation_columns" type="text" label="DB column contains annotation for ganbank file" optional="false" />
-        <param name="fragment_column" type="text" label="Database Fragments Column Name" optional="false" />
-        <param name="db_uri" type="text" label="Database Connection URI" help="postgresql+psycopg2://username:password@db_container_name:port/database" optional="false" />
+        <param name="input" type="data" format="csv" label="Input CSV File" />
+        <param name="table" type="text" label="DB Table Name" optional="false" />
+        <param name="sequence_column" type="text" label="DB Column Contains Sequence For ganbank File" optional="false" />
+        <param name="annotation_columns" type="text" label="DB Column Contains Annotation For Ganbank File" optional="false" />
+        <param name="fragment_column" type="text" label="DB IDs Column Name" optional="false" />
+        <param name="db_uri" type="text" label="DB Connection URI" help="postgresql+psycopg2://username:password@db_container_name:port/database" optional="false" />
     </inputs>    
     <outputs>
         <collection name="output_gb" type="list" label="GenBank Files collection" >
@@ -35,7 +35,7 @@
         </collection>
     </outputs>
     <tests>
-    <!--python get_db_info.py -input 'test-data/test_input.tsv' -sequence_column 'sequence' -annotation_column 'annotation' -db_uri 'postgresql://postgres:RK17@localhost:5432/test_fragments_db' -table 'sample' -fragment_column 'fragment' -output 'test-data/output'-->
+    <!--python get_db_info.py -input 'test-data/test_input.csv' -sequence_column 'sequence' -annotation_column 'annotation' -db_uri 'postgresql://postgres:RK17@localhost:5432/test_fragments_db' -table 'sample' -fragment_column 'fragment' -output 'test-data/output'-->
         <test> 
             <param name="input" value="test_input.csv" />
             <param name="table" value="sample" />
@@ -72,7 +72,17 @@
 Pick Data From DB
 ===================
 
-generate GanDank files from csv file based on SQL DB.
+Implemented a system to generate GenBank (.gb) files from CSV input, based on data retrieved from a PostgreSQL database via URI requests.
+The tool is tested on a locally hosted PostgreSQL database running in a Docker container.
+
+**Parameters**:
+---------------
+* **Input CSV File**: Contains construct IDs in the column 'ID' and their corresponding fragments in the following columns.
+* **DB Table Name**: Name of the target table in the PostgreSQL database.
+* **DB Column Contains Sequence For ganbank File**: Column storing sequence data, expected to start with "ORIGIN". 
+* **DB Column Contains Annotation For Ganbank File**: Column containing annotation data, starting with "FEATURES" and including "LOCUS" information. Other metadata is optional.
+* **DB IDs Column Name**: Column holding the unique fragment IDs.
+* **DB Connection URI**: URI used to connect to the database (e.g., postgresql://user:password@host:port/DB_name).
     ]]></help>
     <citations>
         <citation type="bibtex">