annotate get_data/cfg/README_CFG.md @ 1:0a5e0df17054 draft default tip

Uploaded
author chrisb
date Fri, 06 May 2016 08:05:48 -0400
parents 89592faa2875
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
1 [TOC]
89592faa2875 Uploaded
chrisb
parents:
diff changeset
2
89592faa2875 Uploaded
chrisb
parents:
diff changeset
3 # 1. cfg_get_glycan_from_cells.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
4
89592faa2875 Uploaded
chrisb
parents:
diff changeset
5 Retrieve glycan profiling data from the CFG.
89592faa2875 Uploaded
chrisb
parents:
diff changeset
6
89592faa2875 Uploaded
chrisb
parents:
diff changeset
7 With focus on retrieving the annotated mass spec data (.msa files)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
8
89592faa2875 Uploaded
chrisb
parents:
diff changeset
9 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
10 Yes. see [getcfgcells.xml](getcfgcells.xml)
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 cfg_get_glycan_from_cells.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
16 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
17
89592faa2875 Uploaded
chrisb
parents:
diff changeset
18 This will use the default settings and by default pull all data from the CFG. This may take some time.
89592faa2875 Uploaded
chrisb
parents:
diff changeset
19 The CFG may be unimpressed, if you do this too often.
89592faa2875 Uploaded
chrisb
parents:
diff changeset
20
89592faa2875 Uploaded
chrisb
parents:
diff changeset
21 To specify which data you would like to retrieve :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
22 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
23 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
24 cfg_get_glycan_from_cells.py -s "$species" -p "$investigator" -g "$glycantype" -c "$celltype" -o "$html_file" --filepath "msa_output"
89592faa2875 Uploaded
chrisb
parents:
diff changeset
25 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
26
89592faa2875 Uploaded
chrisb
parents:
diff changeset
27 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
28 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
29 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
30 python cfg_get_glycan_from_cells.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
31 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
32
89592faa2875 Uploaded
chrisb
parents:
diff changeset
33 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
34 Not yet! Although some testing ha been done using the htmlfortesting.html and short-htmlfortesting.html. This code has also been used within Galaxy to retrieve data.
89592faa2875 Uploaded
chrisb
parents:
diff changeset
35 So it _should work just fine..._
89592faa2875 Uploaded
chrisb
parents:
diff changeset
36
89592faa2875 Uploaded
chrisb
parents:
diff changeset
37 In principle:
89592faa2875 Uploaded
chrisb
parents:
diff changeset
38
89592faa2875 Uploaded
chrisb
parents:
diff changeset
39 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
40 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
41 python test_cfg_get_glycan_from_cells.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
42 ```