ngs_server 0.5 → 0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.md +26 -5
  2. data/lib/ngs_server/version.rb +1 -1
  3. data/lib/ngs_server.rb +1 -0
  4. metadata +2 -2
data/README.md CHANGED
@@ -9,19 +9,19 @@
9
9
  2. run "gem install ngs_server" in the terminal
10
10
 
11
11
  ## usage
12
- // in terminal
12
+ # in terminal
13
13
  ngs_server --help
14
14
 
15
- // add data directories to be served
15
+ # add data directories to be served
16
16
  ngs_server add path-to-dir
17
17
 
18
- // start server
18
+ # start server
19
19
  ngs_server start
20
20
  ngs_server start --port 3000
21
- // daemonize
21
+ # daemonize
22
22
  ngs_server start -d
23
23
 
24
- // stop server if daemonized
24
+ # stop server if daemonized
25
25
  ngs_server stop
26
26
 
27
27
 
@@ -40,3 +40,24 @@ see available data sources
40
40
  invoke file: genotypes.vcf.gz with coordinates 1073361 to 1238825 on chromosome 1
41
41
 
42
42
  * http://0.0.0.0:4569/json/vcf/genotypes.vcf.gz?segment=1&min=1073361&max=1238825
43
+
44
+
45
+ ## Example
46
+ # create data directory
47
+ mkdir example-data && cd example-data
48
+
49
+ # download bam file and index
50
+ wget http://bioinformatics.bc.edu/marthlab/download/small.bam
51
+ wget http://bioinformatics.bc.edu/marthlab/download/small.bam.bai
52
+
53
+ # add data directory to ngs_server to be served
54
+ cd ../
55
+ ngs_server add example-data/
56
+
57
+ # start server
58
+ ngs_server start -p 4569
59
+
60
+ # paste following url in browser
61
+ # to download region of bam as json in web browser
62
+ # http://0.0.0.0:4569/json/bam/example-data/small.bam?min=14596532&max=14699000&segment=22
63
+
data/lib/ngs_server/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module NgsServer
2
- VERSION = "0.5"
2
+ VERSION = "0.6"
3
3
  end
data/lib/ngs_server.rb CHANGED
@@ -7,6 +7,7 @@ require 'json'
7
7
 
8
8
  class MyNgsServer < Sinatra::Base
9
9
 
10
+ use Rack::Deflater
10
11
  set :server, 'thin'
11
12
 
12
13
  gempath = File.join(File.dirname(__FILE__), "../")
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: ngs_server
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: "0.5"
5
+ version: "0.6"
6
6
  platform: ruby
7
7
  authors:
8
8
  - Chase Miller
@@ -10,7 +10,7 @@ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-12-28 00:00:00 -05:00
13
+ date: 2012-01-12 00:00:00 -05:00
14
14
  default_executable:
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency