ddi-parser 0.0.1

data/lib/ddi-parser.rb

@@ -0,0 +1,161 @@
+require 'rubygems'
+require 'libxml'
+require 'models/catalog'
+require 'models/category'
+require 'models/category_statistic'
+require 'models/study'
+require 'models/study_date'
+require 'models/variable'
+require 'models/summary_stat'
+
+module DDI
+  class Parser
+    
+    #Given a DDI metadata file, parse it and return study information
+    #
+    #Returns a Nesstar::Study object
+    def parse ddi_file
+      catalog = DDI::Catalog.new
+      study = DDI::Study.new
+      study_info_hash = Hash.new
+      parser = LibXML::XML::Parser.file(ddi_file)
+      doc = parser.parse
+      studynodes = doc.find('//stdyDscr')
+      abstracts = studynodes[0].find('//abstract')
+      abstract = ""
+      abstracts.each do |ab|
+        abstract << ab.content.strip
+      end
+      abstract.strip!
+      study.abstract = abstract
+      study.title = studynodes[0].find('//stdyDscr/citation/titlStmt/titl')[0].first.content.strip
+      study.id = studynodes[0].find('//IDNo')[0].first.content.strip
+      
+      #start and finish dates for study
+      dates = []
+      date = studynodes[0].find('//sumDscr/collDate')
+      date.each do |d|
+        a = d.attributes
+        study_date = DDI::StudyDate.new
+        study_date.type = a.get_attribute('event').value.strip
+        study_date.date = a.get_attribute('date').value.strip
+        dates.push(study_date)
+      end
+      study.dates = dates
+      study.sampling_procedure = studynodes[0].find('//sampProc')[0].first.content.strip unless studynodes[0].find('//sampProc')[0] == nil
+      # study.weight = studynodes[0].find('//sampProc')[0].first.content
+      study.variables = get_variable_information doc
+      return study
+    end
+    
+    private
+    
+    #information about the variables
+    def get_variable_information doc
+      variables = []
+      variable_info_hash = Hash.new
+      docnodes = doc.find('//dataDscr')
+      vargroups = docnodes[0].find('//dataDscr/varGrp')
+      vargroups.each do |vargroup|
+        #hash which holds all the variable groups
+        a = vargroup.attributes
+        groups = a.get_attribute('var')
+        if groups != nil
+          groups = a.get_attribute('var')
+          variable_info_hash[vargroup.find('./labl')[0].first.content] = groups.value.split(' ')
+        # else
+        #             variable_info_hash[vargroup.find('./labl')[0].first.content] = groups.value.split(' ')
+        end
+      end
+      vars = docnodes[0].find('//dataDscr/var')
+      vars.each do |var|
+        variable = DDI::Variable.new
+        var_attr = var.attributes
+        variable.id = var_attr.get_attribute('ID').value.strip unless var_attr.get_attribute('ID') == nil
+        variable.name = var_attr.get_attribute('name').value.strip unless var_attr.get_attribute('name') == nil
+        variable.file = var_attr.get_attribute('files').value.strip unless var_attr.get_attribute('files') == nil
+        variable.interval = var_attr.get_attribute('intrvl').value.strip unless var_attr.get_attribute('intrvl') == nil
+        variable.label = var.find('./labl')[0].content.strip unless var.find('./labl')[0] == nil 
+        rng = var.find('./valrng')
+        if rng != nil
+          if rng[0] != nil
+            range_attr = rng[0].first.attributes
+            max_val = range_attr.get_attribute('max')
+            variable.max = max_val.value.strip unless max_val == nil
+            min_val = range_attr.get_attribute('min')
+            variable.min = min_val.value.strip unless min_val == nil
+          end
+        end
+        q = var.find('./qstn')
+        if q[0] != nil
+          ql = q[0].find('./qstnLit')
+          if ql != nil
+            if ql[0] != nil
+              variable.question = ql[0].first.content.strip
+            end
+          end
+          iv = q[0].find('./ivuInstr')
+          if iv != nil
+            if iv[0] != nil
+              variable.interview_instruction = iv[0].first.content.strip
+            end
+          end
+        end
+        stats = var.find('./sumStat')
+        summary_stats = []
+        stats.each do |stat|
+          a = stat.attributes
+          # summary_stats[a.get_attribute('type').value] = stat.first.content
+          statistic = DDI::SummaryStat.new
+          statistic.type = a.get_attribute('type').value.strip
+          statistic.value = stat.first.content.strip
+          summary_stats.push(statistic)
+        end
+        variable.summary_stats = summary_stats
+        catgry = var.find('./catgry')
+        categories = []
+        #categories in ddi are value domains in mb
+        catgry.each do |cat|
+          category = DDI::Category.new
+          valxml = cat.find('./catValu')
+          if valxml != nil && valxml[0] != nil
+            category.value = valxml[0].first.content.strip unless valxml[0].first == nil
+          else
+            category.value = 'N/A'
+          end
+          labxml = cat.find('./labl')
+          if labxml != nil && labxml[0] != nil
+            category.label = labxml[0].first.content.strip unless labxml[0].first == nil
+          else
+            category.label = 'N/A'
+          end
+          catstats = cat.find('./catStat')
+          category_statistics = []
+          catstats.each do |catstat|
+            category_statistic = DDI::CategoryStatistic.new
+            a = catstat.attributes
+            if a != nil && a.get_attribute('type') != nil
+              category_statistic.type = a.get_attribute('type').value.strip
+              category_statistic.value = catstat.first.content.strip unless catstat.first == nil
+              category_statistics.push(category_statistic)
+            end
+          end
+          category.category_statistics = category_statistics
+          categories.push(category)
+        end
+        #what group is the variable in
+        variable_info_hash.each_key do |key|
+          if variable_info_hash[key].include?(variable.id)
+            variable.group = key.strip
+            break
+          end
+        end
+        
+        variable.categories = categories
+        variables.push(variable)
+      end
+      return variables
+    end
+    
+  end
+end

data/lib/models/catalog.rb

@@ -0,0 +1,10 @@
+module DDI
+  #A Nesstar catalog object, can contain 1 or more studies (ie datasets)
+  class Catalog
+  
+    attr_reader :studies, :label, :description, :nesstar_id, :nesstar_uri
+    attr_writer :studies, :label, :description, :nesstar_id, :nesstar_uri
+  
+  end
+  
+end

data/lib/models/category.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Value information for the rows in a variable
+  class Category
+  
+    attr_reader :value, :label, :category_statistics
+    attr_writer :value, :label, :category_statistics
+  
+  end
+  
+end

data/lib/models/category_statistic.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Stats about a category (ie value domain) belonging to a a variable
+  class CategoryStatistic
+  
+    attr_reader :type, :value
+    attr_writer :type, :value
+  
+  end
+
+end

data/lib/models/study.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Contains a set of variables and belongs to a catalog
+  class Study
+  
+    attr_reader :variables, :abstract, :title, :id, :dates, :sampling_procedure, :weight, :nesstar_id, :nesstar_uri
+    attr_writer :variables, :abstract, :title, :id, :dates, :sampling_procedure, :weight, :nesstar_id, :nesstar_uri
+  
+  end
+  
+end

data/lib/models/study_date.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Dates that are important to the study eg. start date or end date
+  class StudyDate
+  
+    attr_reader :type, :date
+    attr_writer :type, :date
+  
+  end
+  
+end

data/lib/models/summary_stat.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Stats at the variable level, eg how many valid or invalid rows
+  class SummaryStat
+  
+    attr_reader :type, :value
+    attr_writer :type, :value
+  
+  end
+  
+end

data/lib/models/variable.rb

@@ -0,0 +1,11 @@
+module DDI
+  
+  #Information about a variable/column in a dataset
+  class Variable
+  
+    attr_reader :name, :label, :group, :id, :file, :interval, :max, :min, :question, :interview_instruction, :summary_stats, :categories
+    attr_writer :name, :label, :group, :id, :file, :interval, :max, :min, :question, :interview_instruction, :summary_stats, :categories
+      
+  end
+  
+end

data/lib/models/version.rb

@@ -0,0 +1,5 @@
+module DDI
+  module Parser
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: ddi-parser
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ian Dunlop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :runtime
+  version_requirements: *id001
+description: This gem parses ddi metadata files
+email: 
+- ian.dunlop@manchester.ac.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ddi-parser.rb
+- lib/models/catalog.rb
+- lib/models/category.rb
+- lib/models/category_statistic.rb
+- lib/models/study.rb
+- lib/models/study_date.rb
+- lib/models/summary_stat.rb
+- lib/models/variable.rb
+- lib/models/version.rb
+has_rdoc: true
+homepage: http://github.com/mygrid/ddi-parser
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ddi-parser
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: API for parsing ddi metadata files and returning results
+test_files: []
+