Mercurial > repos > tduigou > neo4jsbml
annotate neo4jsbml.xml @ 8:dd3b699966da draft default tip
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
| author | tduigou |
|---|---|
| date | Tue, 06 Jan 2026 11:38:05 +0000 |
| parents | f76091ce926e |
| children |
| rev | line source |
|---|---|
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
1 <tool id="neo4jsbml" name="neo4jsbml" version="@TOOL_VERSION@" profile="21.09" license="MIT"> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
2 <description>Import SBML file into Neo4j</description> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
3 <macros> |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
4 <token name="@TOOL_VERSION@">1.0.1</token> |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
5 </macros> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
6 <requirements> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
7 <requirement type="package" version="@TOOL_VERSION@">neo4jsbml</requirement> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
8 </requirements> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
9 <command detect_errors="exit_code"><![CDATA[ |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
10 neo4jsbml sbml-to-neo4j |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
11 --input-auradb-txt '$input_auradb_txt' |
|
4
94863d48d5da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
3
diff
changeset
|
12 --input-file-sbml '$input_file_sbml' |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
13 #if str($parameter_tag_property_str) != "" |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
14 --parameter-tag-property-str '$parameter_tag_property_str' |
|
4
94863d48d5da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
3
diff
changeset
|
15 #end if |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
16 --input-arrows-json '$input_arrows_json' | tee '$output' |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
17 ]]></command> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
18 <inputs> |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
19 <param name="input_auradb_txt" type="data" format="txt" label="Config file provided by AuraDB"/> |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
20 <param name="input_file_sbml" type="data" format="sbml" label="SBML model"/> |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
21 <param name="parameter_tag_property_str" type="text" label="Identifier of the model"> |
|
4
94863d48d5da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
3
diff
changeset
|
22 <validator type="regex" message="No special characters allowed">^(?:[\w-]*)$</validator> |
|
94863d48d5da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
3
diff
changeset
|
23 </param> |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
24 <param name="input_arrows_json" type="data" format="json" label="Arrow's schema"/> |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
25 </inputs> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
26 <outputs> |
|
5
6941e7dc5117
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 8dd843aac9f23dd9e0036c48914f20889d894ecc
tduigou
parents:
4
diff
changeset
|
27 <data name="output" format="txt" label="${tool.name} - log" /> |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
28 </outputs> |
|
8
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
29 <tests> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
30 <test> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
31 <param name="input_file_sbml" value="e_coli_core.xml.gz" /> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
32 <param name="input_arrows_json" value="PathwayModelisation-2.0.3.json" /> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
33 <param name="input_auradb_txt" value="test_auradb.txt" /> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
34 <param name="parameter_tag_property_str" value="parameter" /> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
35 <output name="output" ftype="txt" > |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
36 <assert_contents> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
37 <has_size value="1000" delta="500" /> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
38 </assert_contents> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
39 </output> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
40 </test> |
|
dd3b699966da
planemo upload for repository https://github.com/brsynth/neo4jsbml commit e8c8f102cab10531ed588be4ecb8a0d01e797f09
tduigou
parents:
7
diff
changeset
|
41 </tests> |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
42 <help><![CDATA[ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
43 Neo4jSbml |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
44 ========= |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
45 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
46 Step 1 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
47 ------ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
48 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
49 Create a schema with `Arrows <https://arrows.app>`_ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
50 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
51 Rules: |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
52 - Nodes are labelled based on SBML object name as defined in the `SBML specification <https://sbml.org>`_ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
53 - Properties are labelled based on SBML object properties as defined the `SBML specification <https://sbml.org>`_ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
54 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
55 Step 2 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
56 ------ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
57 Export your schema at the JSON format. |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
58 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
59 Step 3 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
60 ------ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
61 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
62 Import your data with `neo4jsbml` into Neo4j. |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
63 - Use either a configuration file `ini` or individual parameters |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
64 - Password needs to be store in a file for safety security |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
65 - If you have multiple model in the database, pass a `tag` to identify the model loaded into the database if you want to avoid collision |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
66 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
67 Inputs |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
68 ------ |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
69 |
|
5
6941e7dc5117
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 8dd843aac9f23dd9e0036c48914f20889d894ecc
tduigou
parents:
4
diff
changeset
|
70 - **AuraDB config like**: a txt file with these variables NEO4J_URI, NEO4J_USERNAME, NEO4J_PASSWORD and AURA_INSTANCENAME. One per line like: NEO4J_USERNAME=neo4j |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
71 - **SBML model**: SBML model |
|
5
6941e7dc5117
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 8dd843aac9f23dd9e0036c48914f20889d894ecc
tduigou
parents:
4
diff
changeset
|
72 - **Identifier of the model**: Associate an ID to the nodes (optional) |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
73 - **Arrow's schema**: Schema created with Arrow |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
74 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
75 Ouput |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
76 ----- |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
77 |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
78 - Traceback of the tool |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
79 ]]></help> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
80 <citations> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
81 <citation type="bibtex"> |
|
7
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
82 @article{gricourt_neo4jsbml_2024, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
83 title = {neo4jsbml: import systems biology markup language data into the graph database {Neo4j}}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
84 volume = {12}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
85 issn = {2167-8359}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
86 url = {https://peerj.com/articles/16726}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
87 doi = {10.7717/peerj.16726}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
88 urldate = {2024-01-22}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
89 journal = {PeerJ}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
90 author = {Gricourt, Guillaume and Duigou, Thomas and Dérozier, Sandra and Faulon, Jean-Loup}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
91 month = jan, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
92 year = {2024}, |
|
f76091ce926e
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 96a30e92eab3144b924fdba7b63be10b218160a7
tduigou
parents:
5
diff
changeset
|
93 pages = {e16726}, |
|
0
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
94 } |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
95 </citation> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
96 </citations> |
|
748d0a0925cb
planemo upload for repository https://github.com/brsynth/neo4jsbml commit 513db7f056db275f3f5d8d1337d39ff66012d89f
tduigou
parents:
diff
changeset
|
97 </tool> |
