msf 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. data/README.md +23 -14
  2. data/Rakefile +3 -3
  3. data/VERSION +1 -1
  4. data/msf.gemspec +5 -5
  5. data/spec/msf_spec.rb +2 -2
  6. metadata +6 -6
data/README.md CHANGED
@@ -1,7 +1,8 @@
1
1
  # MSF Parser #
2
2
 
3
- A library for accessing Thermo’s ProteomeDiscoverer’s MSF result file format.
4
- MSF files are SQLite3-based, so the this interface represents a simple API using ActiveRecord that is directly translatable to the database’s schema.
3
+ A Thermo MSF file parser using ActiveRecord as ORM.
4
+ MSF files are SQLite3-based.
5
+ This library provides a simple API using ActiveRecord that is directly translatable to the database’s schema.
5
6
 
6
7
  This gem takes heavily from Angel Pizzaro's thermo_msf gem.
7
8
 
@@ -9,11 +10,11 @@ https://github.com/itmat/thermo_msf
9
10
 
10
11
  ## WARNING ##
11
12
 
12
- This gem has not been developed to completion,
13
- taken only sufficiently far to serve my present needs.
13
+ This gem has not been developed to completion.
14
+ It has only been taken sufficiently far to serve my present needs.
14
15
 
15
16
  It has not been tested on MSF files other than those generated by my instrument
16
- operating my version of Thermo's Proteome Discoverer.
17
+ operating my version of Thermo's Proteome Discoverer (1.3).
17
18
 
18
19
  ## Installation ##
19
20
 
@@ -27,17 +28,25 @@ operating my version of Thermo's Proteome Discoverer.
27
28
  end
28
29
 
29
30
  ibspectra msf_file >> msf_file/msf_file.ibspectra.csv
30
-
31
+
32
+ ## Note ##
33
+
34
+ See erd/erd.png for an Entity Relationship Diagram of the MSF schema.
35
+
31
36
  ## Contributing to msf ##
32
37
 
33
- * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
34
- * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
35
- * Fork the project.
36
- * Start a feature/bugfix branch.
37
- * Commit and push until you are happy with your contribution.
38
- * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
39
- * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
40
-
38
+ * Checkout
39
+ * Fix bugs, add features
40
+ * Test
41
+ * Update version
42
+ * Release
43
+
44
+ git clone git@github.com:bioteam/msf.git; cd msf
45
+ <make changes>
46
+ rspec
47
+ rake version:bump:patch
48
+ rake release
49
+
41
50
  ## Copyright ##
42
51
 
43
52
  Copyright (c) 2012 William Van Etten. See LICENSE.txt for
data/Rakefile CHANGED
@@ -15,10 +15,10 @@ require 'jeweler'
15
15
  Jeweler::Tasks.new do |gem|
16
16
  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
17
  gem.name = "msf"
18
- gem.homepage = "http://github.com/vanetten/msf"
18
+ gem.homepage = "https://github.com/bioteam/msf"
19
19
  gem.license = "MIT"
20
- gem.summary = "ActiveRecord access to MSF file (sqlite3 database)."
21
- gem.description = "An MSF file is sqlite3 dtabase. ActiveRecord is a great ORM for accessing the data. Much taken from Angel Pizarro's thermo_msf."
20
+ gem.summary = "Thermo MSF file parser using ActiveRecord as ORM."
21
+ gem.description = "An MSF file is sqlite3 dtabase. ActiveRecord is a great ORM for accessing the its data. Much has been taken from Angel Pizarro's thermo_msf."
22
22
  gem.email = "bill@bioteam.net"
23
23
  gem.authors = ["William Van Etten"]
24
24
  gem.files.include 'bin/ibspectra'
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.0
1
+ 0.1.1
data/msf.gemspec CHANGED
@@ -5,12 +5,12 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = "msf"
8
- s.version = "0.1.0"
8
+ s.version = "0.1.1"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["William Van Etten"]
12
- s.date = "2012-11-07"
13
- s.description = "An MSF file is sqlite3 dtabase. ActiveRecord is a great ORM for accessing the data. Much taken from Angel Pizarro's thermo_msf."
12
+ s.date = "2012-11-08"
13
+ s.description = "An MSF file is sqlite3 dtabase. ActiveRecord is a great ORM for accessing the its data. Much has been taken from Angel Pizarro's thermo_msf."
14
14
  s.email = "bill@bioteam.net"
15
15
  s.executables = ["ibspectra"]
16
16
  s.extra_rdoc_files = [
@@ -98,11 +98,11 @@ Gem::Specification.new do |s|
98
98
  "spec/msf_spec.rb",
99
99
  "spec/spec_helper.rb"
100
100
  ]
101
- s.homepage = "http://github.com/vanetten/msf"
101
+ s.homepage = "https://github.com/bioteam/msf"
102
102
  s.licenses = ["MIT"]
103
103
  s.require_paths = ["lib"]
104
104
  s.rubygems_version = "1.8.24"
105
- s.summary = "ActiveRecord access to MSF file (sqlite3 database)."
105
+ s.summary = "Thermo MSF file parser using ActiveRecord as ORM."
106
106
 
107
107
  if s.respond_to? :specification_version then
108
108
  s.specification_version = 3
data/spec/msf_spec.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
2
 
3
3
  describe MSF do
4
- it "fails" do
5
- fail "hey buddy, you should probably rename this file and start specing for real"
4
+ it "should write some real tests" do
5
+ true
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: msf
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-11-07 00:00:00.000000000 Z
12
+ date: 2012-11-08 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: bundler
@@ -156,7 +156,7 @@ dependencies:
156
156
  - !ruby/object:Gem::Version
157
157
  version: 2.2.2
158
158
  description: An MSF file is sqlite3 dtabase. ActiveRecord is a great ORM for accessing
159
- the data. Much taken from Angel Pizarro's thermo_msf.
159
+ the its data. Much has been taken from Angel Pizarro's thermo_msf.
160
160
  email: bill@bioteam.net
161
161
  executables:
162
162
  - ibspectra
@@ -244,7 +244,7 @@ files:
244
244
  - msf.gemspec
245
245
  - spec/msf_spec.rb
246
246
  - spec/spec_helper.rb
247
- homepage: http://github.com/vanetten/msf
247
+ homepage: https://github.com/bioteam/msf
248
248
  licenses:
249
249
  - MIT
250
250
  post_install_message:
@@ -259,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
259
259
  version: '0'
260
260
  segments:
261
261
  - 0
262
- hash: -3318715706776057630
262
+ hash: 4171735116220637963
263
263
  required_rubygems_version: !ruby/object:Gem::Requirement
264
264
  none: false
265
265
  requirements:
@@ -271,5 +271,5 @@ rubyforge_project:
271
271
  rubygems_version: 1.8.24
272
272
  signing_key:
273
273
  specification_version: 3
274
- summary: ActiveRecord access to MSF file (sqlite3 database).
274
+ summary: Thermo MSF file parser using ActiveRecord as ORM.
275
275
  test_files: []