annotate convert_detect_formats/rings_kcf_to_image/README_convertKCF.md @ 0:89592faa2875 draft

Uploaded
author chrisb
date Wed, 23 Mar 2016 14:35:56 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
1
89592faa2875 Uploaded
chrisb
parents:
diff changeset
2 [TOC]
89592faa2875 Uploaded
chrisb
parents:
diff changeset
3
89592faa2875 Uploaded
chrisb
parents:
diff changeset
4 # 1. post_kcf_to_image.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
5
89592faa2875 Uploaded
chrisb
parents:
diff changeset
6 **This tool reads a kcf file (containing glycans) and returns images in CFG notation using the server at RINGS. Images are presented in html and the first kcf glycan is returned as a png.**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
7
89592faa2875 Uploaded
chrisb
parents:
diff changeset
8 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
9 Yes. see [post_kcf_to_image.xml](post_kcf_to_image.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
10
89592faa2875 Uploaded
chrisb
parents:
diff changeset
11
89592faa2875 Uploaded
chrisb
parents:
diff changeset
12 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
13 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
14 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
15 python post_kcf_to_image.py $input $pngoutput $htmloutput
89592faa2875 Uploaded
chrisb
parents:
diff changeset
16 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
17
89592faa2875 Uploaded
chrisb
parents:
diff changeset
18 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
19 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
20 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
21 python post_kcf_to_image.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
22 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
23
89592faa2875 Uploaded
chrisb
parents:
diff changeset
24 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
25 Yes. Use test_rings_kcf_to_image.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
26
89592faa2875 Uploaded
chrisb
parents:
diff changeset
27 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
28 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
29 python test_rings_kcf_to_image.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
30 ```