annotate README.txt @ 0:b126ea31824f draft default tip

1st Uploaded
author vmarcon
date Mon, 06 Feb 2017 13:37:49 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
1 REPET dependency
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
2
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
3 For REPET version 2.5.1 (REPET with some patchs, please contact urgi-contact@versailles.inra.fr to get it)
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
4
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
5 REPET dependency handle the creation of essential environment variables.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
6
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
7 !!!!WARNING : REPET has to be installed!!!!
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
8
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
9
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
10 After you have install your tool with this dependency, please go to check if defined environment variables suit with your configuration.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
11 Check this file :
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
12 ***tool_dependency_dir***/repet/2.5/vmarcon/package_repet_2_5/***revision***/env.sh
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
13 Please replace with correct values :
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
14 * tool_dependency_dir (value in galaxy.ini file)
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
15 * revision
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
16
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
17 Then in this file (env.sh) modify variable value in order to adjust it to your
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
18 system :
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
19 - Database connexion (REPET_HOST, REPET_USER, REPET_PW, REPET_DB, REPET_PORT)
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
20 - Job manager (REPET_JOB_MANAGER, REPET_QUEUE)
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
21 - Working environment (REPET_PATH, REPET_NUCL_BANK, REPET_PROT_BANK, REPET_HMM_PROFILES, REPET_RDNA_BANK)
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
22
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
23
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
24 If you want REPET working in a specific temporary directory, fill the variable REPET_TMP_DIR.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
25
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
26 If you don't want to use one or several databanks, remove the corresponding variable.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
27
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
28
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
29
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
30 -------------
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
31 Galaxy Page
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
32 -------------
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
33
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
34 !!!! To get the content of the page and example datasets, please ask it sendig an e-mail at urgi-contact@versailles.inra.fr . !!!!
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
35
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
36
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
37
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
38 To explain in detail to your users how TEannot_lite works, please make a galaxy Page:
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
39 - Connect in your Galaxy.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
40 - Go to the "Saved Pages" (User > Saved Pages).
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
41 - Create a new page ("Add new Page" button in the top right corner) named 'teannot'.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
42 - Click on "teannot" and "Edit content".
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
43 - Paste the content of the URGI TEannot page.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
44 - Save.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
45
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
46 Now you have to create the two Embed Galaxy Object (example on the blue and green area).
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
47 - On the URGI TEannot page, download "DmelChr4.fa", "TElib_DmelChr4.fa" and "TElib_DmelCrh4.classif" by clicking on "Save dataset" (green area).
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
48 - Upload this file on your Galaxy instance where REPET Lite is installed IN A NEW HISTORY.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
49 - Rename these datasets as in example "DmelChr4.fa", "TElib_DmelChr4.fa" and "TElib_DmelCrh4.classif".
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
50 - 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.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
51 - Go back to the page in edition mode.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
52 - Add a green area - Embed Datasets - DmelChr4.fa
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
53 - Add a green area - Embed Datasets - TElib_DmelChr4.fa
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
54 - Add a green area - Embed Datasets - TElib_DmelChr4.classif
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
55 - Add the blue area - Embed Histories - your history with TEannot result.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
56 - Save again.
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
57
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
58 To publish your page:
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
59 - Go to the list of "Saved Pages"
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
60 - Click on "teannot" and "Share or Publish"
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
61 - And "Make Page Accessible and Publish"
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
62
b126ea31824f 1st Uploaded
vmarcon
parents:
diff changeset
63 Now this page is accessible with the URL shown and in Shared Data > Published Pages