diff README.txt @ 0:b126ea31824f draft default tip

1st Uploaded
author vmarcon
date Mon, 06 Feb 2017 13:37:49 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Mon Feb 06 13:37:49 2017 -0500
@@ -0,0 +1,63 @@
+REPET dependency
+
+For REPET version 2.5.1 (REPET with some patchs, please contact urgi-contact@versailles.inra.fr to get it)
+
+REPET dependency handle the creation of essential environment variables. 
+
+!!!!WARNING : REPET has to be installed!!!!
+
+
+After you have install your tool with this dependency, please go to check if defined environment variables suit with your configuration.
+Check this file : 
+***tool_dependency_dir***/repet/2.5/vmarcon/package_repet_2_5/***revision***/env.sh
+Please replace with correct values : 
+  * tool_dependency_dir (value in galaxy.ini file)
+  * revision
+
+Then in this file (env.sh) modify variable value in order to adjust it to your
+system : 
+ - Database connexion (REPET_HOST, REPET_USER, REPET_PW, REPET_DB, REPET_PORT)
+ - Job manager (REPET_JOB_MANAGER, REPET_QUEUE)
+ - Working environment (REPET_PATH, REPET_NUCL_BANK, REPET_PROT_BANK, REPET_HMM_PROFILES, REPET_RDNA_BANK)
+
+
+If you want REPET working in a specific temporary directory, fill the variable REPET_TMP_DIR.
+
+If you don't want to use one or several databanks, remove the corresponding variable.
+
+
+
+-------------
+ Galaxy Page
+-------------
+
+!!!! To get the content of the page and example datasets, please ask it sendig an e-mail at urgi-contact@versailles.inra.fr . !!!!
+
+
+
+To explain in detail to your users how TEannot_lite works, please make a galaxy Page: 
+- Connect in your Galaxy.
+- Go to the "Saved Pages" (User > Saved Pages).
+- Create a new page ("Add new Page" button in the top right corner) named 'teannot'.
+- Click on "teannot" and "Edit content".
+- Paste the content of the URGI TEannot page.
+- Save.
+
+Now you have to create the two Embed Galaxy Object (example on the blue and green area).
+- On the URGI TEannot page, download "DmelChr4.fa", "TElib_DmelChr4.fa" and "TElib_DmelCrh4.classif" by clicking on "Save dataset" (green area).
+- Upload this file on your Galaxy instance where REPET Lite is installed IN A NEW HISTORY.
+- Rename these datasets as in example "DmelChr4.fa", "TElib_DmelChr4.fa" and "TElib_DmelCrh4.classif".
+- Launch "Repet Lite - TEannot" with "DmelChr4.fa" as Fasta alignment input, "TElib_DmelChr4.fa" as Fasta TE library and "TElib_DmelCrh4.classif" as Classification file.
+- Go back to the page in edition mode.
+- Add a green area - Embed Datasets - DmelChr4.fa
+- Add a green area - Embed Datasets - TElib_DmelChr4.fa
+- Add a green area - Embed Datasets - TElib_DmelChr4.classif
+- Add the blue area - Embed Histories - your history with TEannot result.
+- Save again.
+
+To publish your page:
+- Go to the list of "Saved Pages" 
+- Click on "teannot" and "Share or Publish"
+- And "Make Page Accessible and Publish"
+
+Now this page is accessible with the URL shown and in Shared Data > Published Pages