mapp2g 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d3b7c217addd7e92a9b0dc4d2af710c216d7dbcf86c2416018ac80bee287e1c
-  data.tar.gz: 562dbf402617e18af3b2e32cb32fb1e5f157ec783aaa6b61f2f44a5cf3877acc
+  metadata.gz: '029a95186aca02659011cc06f0cdc67f85aa7c8fbda820c06e504a772158cd0a'
+  data.tar.gz: bbaac99c22269dfbba7980ee2ee7c90c7f6bc7f0874b57cd397c1f6d803f953e
 SHA512:
-  metadata.gz: 6df38d0b72858bd49d354d0b72eeca57a70cfc80a075444bcffd8ecfcd4b59945395a76a3d38e70caea74254bce0e62f82039f15db6ca23566204444bc9bb5b2
-  data.tar.gz: 01174fd8de53e2e5f7d6a3021ff8789b242a53af4d8968bc3eaf6c3e1c67795826af82b95e7f0c1290e6c9d888d560d4488de5f1de4774c78d3b793dd52f2dcf
+  metadata.gz: 3f41a7fad9ef596f1af730dfd235895c1f04365f5672d2ead4a6ae1979738ee3ba601707c440d48708e75e6f0d6b49944e6ba2861bfeac1ca004ceebba48783e
+  data.tar.gz: ec1c3ecd64349b0b880a35d4148066ce4a4c5888f789c8223b0fe93d089c254d11341f293e9e535e4c29b2e29508489eb945f29c72756b52ac4f0b64f6b90590

data/README.md

@@ -1,34 +1,42 @@
 # Mapp2g
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mapp2g`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+### Pre-requisites
 
-Install the gem and add to the application's Gemfile by executing:
+  * NCBI blast
+  * exonerate
+  
+These two software should be installed. mapp2g is wrtten in Ruby. Ruby sholud be installed.
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+### Install mapp2g using gem
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```
+gem install mapp2g
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+```
+Usage: mapp2g [options]
+    -q, --query QUERY                query amino acid sequences in FASTA format
+    -g, --genome BLASTDB             genome reference as blastdb
+    -o, --outdir [OUTDIR]            output directory. DEFAULT: mapp2g_out_{process_id}
+    -v, --version                    show version number
+    -h, --help                       show this help message and exit
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+(example)
+```
+mapp2g -q human_genome.fasta -q p53.protein.fasta
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Reference genomes should be formated in blastdb before running mapp2g. blastdb can be made as follws:
 
-## Contributing
+```
+makeblastdb -in human_genome.fasta -dbtype nucl -parse_seqids
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mapp2g.
 
 ## License
 

data/exe/mapp2g

@@ -15,14 +15,22 @@ begin
     puts Mapp2g::VERSION
     exit
   end
-  opt.on("-q QUERY", "--query", "query amino acid sequences in FASTA format"){|v| OPTS[:q] = v}
-  opt.on("-g BLASTDB", "--genome", "genome reference as blastdb"){|v| OPTS[:g] = v}
+  opt.on("-q QUERY", "--query", "query amino acid sequences in FASTA format. REQUIRED."){|v| OPTS[:q] = v}
+  opt.on("-g BLASTDB", "--genome", "genome reference as blastdb. REQUIRED."){|v| OPTS[:g] = v}
   opt.on("-o [OUTDIR]", "--outdir", "output directory. DEFAULT: mapp2g_out_{process_id}"){|v| OPTS[:o] = v}
   opt.on_tail('-h', '--help', 'show this help message and exit') do
     puts opt
     exit
   end
+
+  if ARGV.size == 0
+    puts opt
+    exit
+  end
+
   opt.parse!(ARGV)
+
+
 rescue => e
   puts "ERROR: #{e}\nSee #{opt}"
   exit

data/lib/mapp2g/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mapp2g
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mapp2g
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shuji Shigenobu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies: []
 description: mapp2g is a bioinformatics software, which map and align protein sequences
   (amino acid sequences) to genome references in a splicing-aware way. mapp2g alignment