annotate README.md @ 4:bda10049b902 draft

Uploaded correct files instead of GitHub fetched
author hogart
date Tue, 10 Mar 2015 05:54:18 -0400
parents 75a1e3d0842f
children 5f95a9afe2ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
1 # Galaxy Tool wrapper for UNAFold #
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
2
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
3 This is the [Galaxy](http://usegalaxy.org) wrapper for the [UNAFold](http://mfold.rna.albany.edu/?q=DINAMelt/software). UNAFold software was developed for nucleic acid folding and hybridization prediction ([doi: 10.1007/978-1-60327-429-6_1](http://dx.doi.org/10.1007/978-1-60327-429-6_1), [doi: 10.1093/nar/gki591](http://dx.doi.org/10.1093/nar/gki591)). This wrapper is not yet deposited in the Tool-Shed repository, so this is the single place where it can downloaded.
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
4
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
5 ## Installation ##
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
6
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
7 * Save [UNAFold.pl](http://mfold.rna.albany.edu/?q=DINAMelt/software) in your $PATH, that is accesable to the Galaxy.
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
8
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
9 * Create the directory `unafold` in `$GALAXY_DIR/tools/` and copy `unafold.xml` and `unafold.sh` files into it.
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
10 * Add the Galaxy tool definition to the `tools_conf.xml`:
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
11 ```html
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
12 <section id="unafold_tool" name="UNAFold">
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
13 <tool file="unafold/unafold.xml" />
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
14 </section>`
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
15 ```
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
16
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
17 * Please, be sure that `zip` datatype is registered in your Galaxy instance. If not, add the following string to the `datatypes_conf.xml` file:
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
18 ```html
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
19 <datatype extension="zip" type="galaxy.datatypes.binary:Binary" mimetype="application/zip" subclass="True" />
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
20 ```
2
75a1e3d0842f Uploaded README.md
hogart
parents:
diff changeset
21
4
bda10049b902 Uploaded correct files instead of GitHub fetched
hogart
parents: 2
diff changeset
22 * Reload the Galaxy instance.