dirseq 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7b2362c43bff2a2cd43f0dc727bf8d713e4ab3c4
-  data.tar.gz: 7a56c16b7bfe38543c8d217d9307dc4f18ea5d21
+SHA256:
+  metadata.gz: a64587e48a659047ad59f42609c2af922baaf611949eea5c2e9ac274c1eadc7e
+  data.tar.gz: 56326ebb3b95dce59a5b833f82b5a7601138adddde9ea391d33428f744f4ab77
 SHA512:
-  metadata.gz: 526abeb2d9b53cc0b0d26b3688d9b01ed44dea5d9b010d575b64922c8b3ae3d7097134db5fe23cff29855aa05f46449563ce7fcc575601a30e901782d90aaf7d
-  data.tar.gz: 8702f8ba681c9e161f97f76cfd763593ad266a77acf813a194ecbc7390ef08d46d6c0a68d6b60bebe46f2b9d86bc6bb0a1dbf51c0f1ae3861d33b27e775b1e59
+  metadata.gz: ae30379a9368a92f1941614f201cbe2507ae6a34462dd03e2b9e811355e2ecf4f14db152251b8f08821adf19e6bb40f8b9d445cb7040926dd9d9a5a113ae8a5d
+  data.tar.gz: d45ed71712aa00509f10091ed45e43ebd28aad85f67fe23ffca2e385fa1afa9fdf0f9a350fd3ad15a109f535b4f7b418055403b601049fdc8ebf528d9dd34df1

data/Gemfile

@@ -9,11 +9,10 @@ gem "bio", "~>1.4", ">=1.4.2"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", "~> 3.5"
-  gem "rdoc", "~> 3.12"
-  gem "simplecov", "~> 0.8"
-  gem "jeweler", "~> 2.0"
-  gem "bundler", "~> 1.6"
-  gem "rspec", "~> 2.99"
+  #gem "shoulda", "~> 3.5"
+  #gem "simplecov", "~> 0.8"
+  gem "jeweler", "~> 2.3"
+  gem "bundler", "~> 2.1"
+  gem "rspec", "~> 3.0"
   gem 'pry', '~>0.10'
 end

data/README.md

@@ -13,8 +13,8 @@ Won't work just yet:
 gem install dirseq
 ```
 Requires:
-* samtools (tested with 0.1.19)
-* bedtools (tested with 2.20.1)
+* samtools (tested with 0.1.19 and 1.0+)
+* bedtools (tested with 2.24.0) - old versions won't work.
 * Ruby (tested with 2.1.1)
 
 ## Usage
@@ -32,8 +32,13 @@ $ dirseq -h
 
 Optional parameters:
 
+        --forward-read-only          consider only forward reads (i.e. read1) and ignore reverse reads. [default false]
         --ignore-directions          ignore directionality, give overall coverage [default: false i.e. differentiate between directions]
-
+        --measure-type TYPE          what to count for each gene [options: count, coverage][default: coverage]
+        --accepted-feature-types TYPE
+                                     Print only features of these type(s) [default CDS]
+        --comment-fields             Print elements from the comments in the GFF file [default ID]
+        
 Verbosity:
 
     -q, --quiet                      Run quietly, set logging to ERROR level [default INFO]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.4.1

data/bin/dirseq

@@ -9,11 +9,23 @@ require 'tempfile'
 
 SCRIPT_NAME = File.basename(__FILE__); LOG_NAME = SCRIPT_NAME.gsub('.rb','')
 
+COVERAGE_COUNT_TYPE = 'coverage'
+COUNT_COUNT_TYPE = 'count'
+COUNT_TYPES = [
+  COUNT_COUNT_TYPE,
+  COVERAGE_COUNT_TYPE
+]
+
 # Parse command line options into the options hash
 options = {
   :ignore_directions => false,
   :logger => 'stderr',
   :log_level => 'info',
+  :count_type => COVERAGE_COUNT_TYPE,
+  :forward_read_only => false,
+  :accepted_feature_types => ['CDS'],
+  :comment_fields_to_print => ['ID'],
+  :sam_filter_flags => "-F0x100 -F0x800",
 }
 o = OptionParser.new do |opts|
   opts.banner = "
@@ -28,9 +40,27 @@ o = OptionParser.new do |opts|
     options[:gff] = arg
   end
   opts.separator "\nOptional parameters:\n\n"
+  opts.on("--forward-read-only", "consider only forward reads (i.e. read1) and ignore reverse reads. [default #{options[:forward_read_only]}]") do
+    options[:forward_ready_only] = true
+  end
   opts.on("--ignore-directions", "ignore directionality, give overall coverage [default: false i.e. differentiate between directions]") do |arg|
     options[:ignore_directions] = true
   end
+  opts.on("--measure-type TYPE", "what to count for each gene [options: #{COUNT_TYPES.join(', ')}][default: #{options[:count_type]}]") do |arg|
+    raise "Unexpected count type detected" if not COUNT_TYPES.include?(arg)
+    options[:count_type] = arg
+  end
+  opts.on("--accepted-feature-types TYPE", Array,
+          "Print only features of these type(s) [default #{options[:accepted_feature_types].join(',')}]") do |arg|
+    options[:accepted_feature_types] = Set.new(arg)
+  end
+  opts.on("--comment-fields", Array,
+          "Print elements from the comments in the GFF file [default #{options[:comment_fields_to_print].join(',')}]") do |arg|
+    options[:comment_fields_to_print] = arg
+  end
+  opts.on("--sam-filter-flags", "Apply these samtools filters [default: #{options[:sam_filter_flags]}]") do |arg|
+    options[:sam_filter_flags] = arg
+  end
 
   # logger options
   opts.separator "\nVerbosity:\n\n"
@@ -47,6 +77,11 @@ Bio::Log::CLI.logger(options[:logger]); Bio::Log::CLI.trace(options[:log_level])
 
 gff_file = options[:gff]
 bam_file = options[:bam]
+accepted_feature_types = options[:accepted_feature_types]
+
+if options[:count_type] != COVERAGE_COUNT_TYPE and options[:ignore_directions]
+  raise "ignore_directions + count_type != coverage is currently unsupported"
+end
 
 
 calculate_cov = lambda do |covs, num_covs|
@@ -76,14 +111,26 @@ get_covs = lambda do |cov_lines|
     #96 #coverage
     #0.0208333
     feat = splits[0..8]
+    feature_type = feat[2]
+    if not accepted_feature_types.include?(feature_type)
+      log.debug "Skipping feature as it is of type #{feature_type}"
+      next
+    end
     if feat != previous_feature
       feature_to_covs[previous_feature] = calculate_cov.call(covs, num_covs) unless previous_feature.nil?
       covs = []
       num_covs = 0
     end
-    num = splits[10].to_i
-    covs.push num*splits[9].to_i
-    num_covs += num
+    if splits.length == 13 # -hist
+      num = splits[10].to_i
+      covs.push num*splits[9].to_i
+      num_covs += num
+    elsif splits.length == 10 # -count
+      covs.push splits[9].to_i
+      num_covs += 1
+    else
+      raise "Unexpected bedtools output line: #{line}"
+    end
     previous_feature = feat
   end
   feature_to_covs[previous_feature] = calculate_cov.call(covs, num_covs)
@@ -93,13 +140,57 @@ end
 
 # Remove the ##FASTA and afterwards from the GFF file as this makes bedtools <2.25 fail
 # https://github.com/arq5x/bedtools2/issues/235#issuecomment-103776618
-no_fasta_gff = Tempfile.new('dirseq')
+no_fasta_gff = Tempfile.new(['dirseq','.gff3'])
 Bio::Commandeer.run "sed '/^##FASTA$/,$d' #{gff_file.inspect} > #{no_fasta_gff.path}", :log => log
 gff_file = no_fasta_gff.path
 
+
+
+
+
+# Find featureless contigs. Need to so that bedtools coverage -sorted does not complain
+if not File.exists?("#{bam_file}.bai")
+  raise "Input bam file must be indexed, but the index file does not exist"
+end
+
+chromosome_file = Tempfile.new('bam_contigs')
+log.info "Listing contigs in sorted order .."
+cmd = "samtools idxstats #{bam_file.inspect} |cut -f1,2 |grep -v '^*' >#{chromosome_file.path.inspect}"
+Bio::Commandeer.run(cmd, :log => log)
+
+log.info "Finding featureless contigs"
+cmd = "grep -v '^#' #{gff_file.inspect} |cut -f1 |sort |uniq |grep -vFw -f /dev/stdin #{chromosome_file.path.inspect} |cut -f1"
+featureless_contigs = Bio::Commandeer.run(cmd, :log => log).lines.map(&:chomp).reject{ |ref| ref=='*' }
+log.info "Found #{featureless_contigs.length} featureless contigs"
+
+# Sort the GFF
+dummy_features = featureless_contigs.collect do |ref|
+  [ref,
+   'dirseq',
+   'misc_RNA',
+   '1',
+   '2',
+   '.',
+   '+',
+   '0',
+   "ID=#{ref}_dummy_feature"].join("\t")
+end
+sorted_gff_file_f = Tempfile.new(['sorted_gff','.gff3'])
+sorted_gff_file = sorted_gff_file_f.path
+Tempfile.open(["extra_features",'.gff']) do |ef|
+  ef.puts dummy_features.join("\n")
+  ef.close
+
+  cmd = "cat #{ef.path} #{gff_file.inspect} |bedtools sort -i /dev/stdin -faidx #{chromosome_file.path.inspect} >#{sorted_gff_file.inspect}"
+  log.info "Running bedtools sort"
+  Bio::Commandeer.run(cmd, :log => log)
+end
+
+
+
 covs_fwd = nil
 if options[:ignore_directions]
-  cmd1 = "bedtools coverage -b #{bam_file.inspect} -a #{gff_file.inspect} -hist"
+  cmd1 = "samtools view -u #{options[:sam_filter_flags]} #{bam_file.inspect} |bedtools coverage -b /dev/stdin -a #{gff_file.inspect} -hist"
   cov_lines_fwd = Bio::Commandeer.run cmd1, :log => log
   log.info "Parsing coverage profiles"
   covs_fwd = get_covs.call(cov_lines_fwd)
@@ -108,10 +199,14 @@ else
   # fwd read 1
   read1_flag = '-F128' #account for read1 in pair, as well as single reads mapping
   read2_flag = '-f128'
-  cmdf1 = "samtools view -u #{read1_flag} #{bam_file.inspect} |bedtools coverage -b /dev/stdin -a #{gff_file.inspect} -hist -s"
-  cmdf2 = "samtools view -u #{read2_flag} #{bam_file.inspect} |bedtools coverage -b /dev/stdin -a #{gff_file.inspect} -hist -s"
-  cmdr1 = "samtools view -u #{read1_flag} #{bam_file.inspect} |bedtools coverage -b /dev/stdin -a #{gff_file.inspect} -hist -S"
-  cmdr2 = "samtools view -u #{read2_flag} #{bam_file.inspect} |bedtools coverage -b /dev/stdin -a #{gff_file.inspect} -hist -S"
+  bedtools_type_flag = '-hist'
+  if options[:count_type] == COUNT_COUNT_TYPE
+    bedtools_type_flag = '-counts'
+  end
+  cmdf1 = "samtools view #{options[:sam_filter_flags]} -u #{read1_flag} #{bam_file.inspect} |bedtools coverage -sorted -g #{chromosome_file.path.inspect} -b /dev/stdin -a #{sorted_gff_file.inspect} -s #{bedtools_type_flag}"
+  cmdf2 = "samtools view #{options[:sam_filter_flags]} -u #{read2_flag} #{bam_file.inspect} |bedtools coverage -sorted -g #{chromosome_file.path.inspect} -b /dev/stdin -a #{sorted_gff_file.inspect} -s #{bedtools_type_flag}"
+  cmdr1 = "samtools view #{options[:sam_filter_flags]} -u #{read1_flag} #{bam_file.inspect} |bedtools coverage -sorted -g #{chromosome_file.path.inspect} -b /dev/stdin -a #{sorted_gff_file.inspect} -S #{bedtools_type_flag}"
+  cmdr2 = "samtools view #{options[:sam_filter_flags]} -u #{read2_flag} #{bam_file.inspect} |bedtools coverage -sorted -g #{chromosome_file.path.inspect} -b /dev/stdin -a #{sorted_gff_file.inspect} -S #{bedtools_type_flag}"
 
   command_to_parsed = lambda do |cmds, name|
     covs_lines_initial = cmds.collect do |cmd|
@@ -122,15 +217,23 @@ else
       get_covs.call(lines)
     end
     covs = covs_initial[0]
-    covs_initial[1].each do |cov_key, cov|
-      covs[cov_key] += cov
+    if covs_initial.length > 1
+      covs_initial[1].each do |cov_key, cov|
+        covs[cov_key] += cov
+      end
     end
     covs #'return' from lambda
   end
 
   # Agreeing reads (those whose template are fwd along the reference sequence) are either first and fwd, or second and rev
-  covs_fwd = command_to_parsed.call([cmdf1,cmdr2], 'reads with same direction as their reference')
-  covs_rev = command_to_parsed.call([cmdf2,cmdr1], 'reads with opposing direction as their reference')
+  commands_fwd = [cmdf1,cmdr2]
+  commands_rev = [cmdf2,cmdr1]
+  if options[:forward_ready_only]
+    commands_fwd = [cmdf1]
+    commands_rev = [cmdr1]
+  end
+  covs_fwd = command_to_parsed.call(commands_fwd, 'reads with same direction as their reference')
+  covs_rev = command_to_parsed.call(commands_rev, 'reads with opposing direction as their reference')
 end
 
 headers = [
@@ -142,11 +245,19 @@ headers = [
 ]
 if options[:ignore_directions]
   headers.push 'average_coverage'
-else
+elsif options[:count_type] == COVERAGE_COUNT_TYPE
   headers.push 'forward_average_coverage'
   headers.push 'reverse_average_coverage'
+elsif options[:count_type] == COUNT_COUNT_TYPE
+  headers.push 'forward_read_count'
+  headers.push 'reverse_read_count'
+else
+  raise
 end
 headers.push 'annotation'
+options[:comment_fields_to_print].each do |field|
+  headers.push field
+end
 puts headers.join("\t")
 
 covs_fwd.each do |feature, cov_fwd|
@@ -169,5 +280,13 @@ covs_fwd.each do |feature, cov_fwd|
   ]
   to_print.push cov_rev unless options[:ignore_directions]
   to_print.push product
+  options[:comment_fields_to_print].each do |field|
+    answer1 = record.attributes.select{|a| a[0] == field}
+    if answer1.empty?
+      to_print.push ''
+    else
+      to_print.push answer1[0][1]
+    end
+  end
   puts to_print.join("\t")
 end

data/spec/script_spec.rb

@@ -6,9 +6,9 @@ describe 'script' do
 
   it "should regular mode" do
     answer = %w(
-    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation
+    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation	ID
     ).join("\t")+"\n"+%w(
-    contig_100	CDS	2	127	+	0.0	1.1428571428571428	unannotated
+    contig_100	CDS	2	127	+	0.0	1.1428571428571428	unannotated	40_1
     ).join("\t")+"\n"
 
     found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/eg.gff -q"
@@ -20,9 +20,9 @@ describe 'script' do
     found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/eg.gff -q --ignore-direction"
 
     answer = %w(
-    contig	type	start	end	strand	average_coverage	annotation
+    contig	type	start	end	strand	average_coverage	annotation	ID
     ).join("\t")+"\n"+%w(
-    contig_100	CDS	2	127	+	1.1428571428571428	unannotated
+    contig_100	CDS	2	127	+	1.1428571428571428	unannotated	40_1
     ).join("\t")+"\n"
 
     found.should == answer
@@ -30,9 +30,9 @@ describe 'script' do
 
   it 'should not fail when the GFF has a FASTA section' do
     answer = %w(
-    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation
+    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation	ID
     ).join("\t")+"\n"+%w(
-    contig_100	CDS	2	127	+	0.0	1.1428571428571428	unannotated
+    contig_100	CDS	2	127	+	0.0	1.1428571428571428	unannotated	40_1
     ).join("\t")+"\n"
 
     found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/eg_with_fasta.gff -q"
@@ -42,13 +42,37 @@ describe 'script' do
 
   it 'should print annotation out properly' do
     answer = %w(
-    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation
+    contig	type	start	end	strand	forward_average_coverage	reverse_average_coverage	annotation	ID
     ).join("\t")+"\n"+%w(
     contig_100	CDS	2	127	+	0.0	1.1428571428571428	putative
-    ).join("\t")+" methyltransferase YcgJ\n"
+    ).join("\t")+" methyltransferase YcgJ	PROKKA_00001\n"
 
     found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/realer.gff -q"
 
     found.should == answer
   end
+
+  it 'should print counts correctly' do
+    answer = %w(
+    contig	type	start	end	strand	forward_read_count	reverse_read_count	annotation	ID
+    ).join("\t")+"\n"+%w(
+    contig_100	CDS	2	127	+	0.0	2.0	putative
+    ).join("\t")+" methyltransferase YcgJ	PROKKA_00001\n"
+
+    found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/realer.gff -q --measure-type count"
+
+    found.should == answer
+  end
+
+  it 'should count only the forward read when asked' do
+    answer = %w(
+    contig	type	start	end	strand	forward_read_count	reverse_read_count	annotation	ID
+    ).join("\t")+"\n"+%w(
+    contig_100	CDS	2	127	+	0.0	1.0	putative
+    ).join("\t")+" methyltransferase YcgJ	PROKKA_00001\n"
+
+    found = Bio::Commandeer.run "#{path_to_script} --bam #{data_dir}/eg.bam --gff #{data_dir}/realer.gff -q --measure-type count --forward-read-only"
+
+    found.should == answer
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dirseq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ben J. Woodcroft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bio-commandeer
@@ -42,106 +42,64 @@ dependencies:
   name: bio
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.2
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +134,7 @@ files:
 - lib/bio-rnaseq_transcription_directionality.rb
 - lib/bio-rnaseq_transcription_directionality/rnaseq_transcription_directionality.rb
 - spec/data/eg.bam
+- spec/data/eg.bam.bai
 - spec/data/eg.gff
 - spec/data/eg_with_fasta.gff
 - spec/data/realer.gff
@@ -185,7 +144,7 @@ homepage: http://github.com/wwood/dirseq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,9 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: FPKG calculator for metatranscriptomics
 test_files: []