ruby-igv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 224cade620bf730aabd99e3f5369c10eea4a18714d5713148cd73044b7236ce8
+  data.tar.gz: 11b31803bc1df5b2393f5d0c980caf7092aaf86defd94b89a88ed366e3dc318f
+SHA512:
+  metadata.gz: e8f1e9a25e9467ddcb0ddb8571b81910fb48e607ca898a34290a28b62533b1b617826c139f37008c019990db76a6e2a91fc500e6a0b740d24ba16ce7d3816bb9
+  data.tar.gz: 0f9f95a3fc8cbdf52bee48f1830392b7f64594565de16fc5108f3af3ffc6aa2517e0af4035c44967122a27e1f2524f4e0370b4517d43f313ed869ce51d3b7468

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 kojix2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Ruby-IGV
+
+Using Integrative Genomics Viewer (IGV) with the Ruby language.
+
+Based on [brentp/bio-playground/igv](https://github.com/brentp/bio-playground).
+
+## Installation
+
+```ruby
+gem install ruby-igv
+```
+
+## Usage
+
+```ruby
+igv = IGV.new
+igv.gnome 'hg19'
+igv.load 'http://www.broadinstitute.org/igvdata/1KG/pilot2Bams/NA12878.SLX.bam'
+igv.go 'chr1:45,600-45,800'
+igv.save '/tmp/r/region.svg'
+igv.save '/tmp/r/region.png'
+igv.send 'echo' #whatever
+```
+
+## Contributing
+
+* [Report bugs](https://github.com/kojix2/ruby-igv/issues)
+* Fix bugs and submit [pull requests](https://github.com/kojix2/ruby-igv/pulls)
+* Write, clarify, or fix documentation
+* Suggest or add new features
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/igv.rb

@@ -0,0 +1,94 @@
+require 'igv/version'
+require 'socket'
+require 'fileutils'
+require 'pathname'
+
+class IGV
+  class Error < StandardError; end
+
+  attr_reader :host, :port, :snapshot_dir, :commands
+  def initialize(host: '127.0.0.1', port: 60_151, snapshot_dir: '/tmp/igv')
+    @host = host
+    @port = port
+    @commands = []
+    connect
+    set_snapshot_dir(snapshot_dir)
+  end
+
+  # def self.start
+  # end
+
+  def connect
+    @socket&.close
+    @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
+    addr = Socket.sockaddr_in(port, host)
+    @socket.connect(addr)
+  end
+
+  def go(position)
+    send 'goto ' + position
+  end
+  alias goto go
+
+  def genome(name_or_path)
+    send 'genome ' + name_or_path
+  end
+
+  def load(path_or_url)
+    send 'load ' + path_or_url
+  end
+
+  def region(contig, start, end_)
+    send ['region', contig, start, end_].join(' ')
+  end
+
+  def sort(option = 'base')
+    if %w[base position strand quality sample readGroup].include? option
+      send 'sort ' + option
+    else
+      raise 'options is one of: base, position, strand, quality, sample, and readGroup.'
+    end
+  end
+
+  def snapshot_dir=(snapshot_dir)
+    snapshot_dir = File.expand_path(snapshot_dir)
+    return if snapshot_dir == @snaphot_dir
+
+    FileUtils.mkdir_p(snapshot_dir)
+    send "snapshotDirectory #{snapshot_dir}"
+    @snapshot_dir = snapshot_dir
+  end
+  alias set_snapshot_dir snapshot_dir=
+
+  def expand(_track = '')
+    send "expand #{track}"
+  end
+
+  def collapse(_track = '')
+    send "collapse #{track}"
+  end
+
+  def clear
+    send 'clear'
+  end
+
+  def send(cmd)
+    @commands << cmd
+    cmd += "\n"
+    @socket.puts(cmd.encode(Encoding::UTF_8))
+    @socket.readline.chomp("\n")
+  end
+
+  def save(file_path = nil)
+    if file_path
+      # igv assumes the path is just a single filename, but
+      # we can set the snapshot dir. then just use the filename.
+      dir_path = Pathname(File.expand_path(file_path)).dirname
+      set_snapshot_dir(dir_path)
+      send 'snapshot ' + File.basename(file_path)
+    else
+      send 'snapshot'
+    end
+  end
+  alias snapshot save
+end

data/lib/igv/version.rb

@@ -0,0 +1,3 @@
+class IGV
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ruby-igv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kojix2
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Operate IGV (Integrative Genomics Viewer) from Ruby.
+email:
+- 2xijok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/igv.rb
+- lib/igv/version.rb
+homepage: https://github.com/kojix2/ruby-igv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Operate IGV (Integrative Genomics Viewer) from Ruby.
+test_files: []