Mercurial > repos > ggricourt > rp_fba_analysis

annotate README @ 1:9142d12aa3a9 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
author ggricourt
date Fri, 11 Feb 2022 16:10:33 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
1 # rpFbaAnalysis -- Run OptGene, OptKnock with an heterologous pathway
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
2
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
3 The open-source software package rpFbaAnalysis is available here : https://github.com/brsynth/rptools/tree/master/rptools/rpFbaAnalysis
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
4
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
5 ## How to run rpFbaAnalysis wrapper tests
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
6
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
7 In order to execute tests on rpFbaAnalysis wrapper, you need to:
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
8
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
9 - Connect to your galaxy instance in interactive mode:
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
10
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
11 ```bash
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
12 docker exec -it -u root galaxy_galaxy_1 bash
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
13 ```
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
14 - Copy all the contents of `test-data` folder into your own test-data directory which is located in your local galaxy instance : `/galaxy/test-data`. It contains all the input files and expected output files needed for the tests.
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
15
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
16 - Install Planemo:
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
17 You can see here the documentation for Planemo Installation : https://planemo.readthedocs.io/en/latest/installation.html
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
18 Note that they recommand to install Planemo by setting up a virtual environment:
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
19
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
20 ```bash
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
21 python3 -m venv planemo
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
22 . planemo/bin/activate
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
23 pip install -U planemo
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
24 ```
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
25
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
26 Upgrade pip if needed.
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
27
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
28 - run the tests:
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
29
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
30 ```bash
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
31 planemo test --conda_channels conda-forge --conda_debug tools/BRSynthTools/rpFbaAnalysis/wrap.xml
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
32 ```
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
33
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
34 IMPORTANT: Maybe you will need to remove CONDA from your PATH for the command `planemo test` to run correctly. To do that, you can edit this file `~/.bashrc`, comment this line `PATH="/root/anaconda3/bin:$PATH"` and save changes.
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
35
9142d12aa3a9 "planemo upload for repository https://github.com/brsynth/rpFbaAnalysis commit ee9dd570c679d19cb4cdd54cc7414f64ca4cd07d"
ggricourt
parents:
diff changeset
36 Planemo will output an html test summary `tool_test_output.html`.