pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/{api_v1_trials_records_get200_response_trials_inner_linked_drugs_inner.rb → biomarker_publishing_companies_row.rb}

@@ -14,28 +14,67 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInner
-    attr_accessor :molecule_id
+  # One row of the biomarker_publishing_companies dataset: one row per biomarker gene and company. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BiomarkerPublishingCompaniesRow
+    # The biomarker route key of the gene the papers name (the gene symbol); the entry key for the biomarkers object type.
+    attr_accessor :route_key
 
-    attr_accessor :molecule_name
+    # The gene symbol.
+    attr_accessor :gene_symbol
 
-    attr_accessor :registered_as
+    # Company level: the publisher's company.
+    attr_accessor :publisher_company_id
 
-    attr_accessor :matched_from_name_part
+    # Display name of the publisher's company.
+    attr_accessor :publisher_company_name
 
-    attr_accessor :brand_count
+    # Group level: the publisher's current ultimate parent company; a root company's group is itself.
+    attr_accessor :publisher_group_id
 
-    attr_accessor :brands
+    # Display name of the publisher's group.
+    attr_accessor :publisher_group_name
+
+    # Papers that name the gene from the company's organizations (a consortium paper is excluded).
+    attr_accessor :n_publications
+
+    # The company's organizations the papers reach.
+    attr_accessor :n_member_orgs
+
+    # Strongest affiliation match tier.
+    attr_accessor :best_match_tier
+
+    # Earliest publication year.
+    attr_accessor :first_pub_year
+
+    # Latest publication year.
+    attr_accessor :last_pub_year
+
+    # A sample of the supporting PubMed ids.
+    attr_accessor :supporting_pmids
+
+    # True when the sample is shorter than the paper count.
+    attr_accessor :supporting_pmids_truncated
+
+    # Papers left out because they name too many organizations.
+    attr_accessor :n_papers_excluded_as_consortium
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'molecule_id' => :'molecule_id',
-        :'molecule_name' => :'molecule_name',
-        :'registered_as' => :'registered_as',
-        :'matched_from_name_part' => :'matched_from_name_part',
-        :'brand_count' => :'brand_count',
-        :'brands' => :'brands'
+        :'route_key' => :'route_key',
+        :'gene_symbol' => :'gene_symbol',
+        :'publisher_company_id' => :'publisher_company_id',
+        :'publisher_company_name' => :'publisher_company_name',
+        :'publisher_group_id' => :'publisher_group_id',
+        :'publisher_group_name' => :'publisher_group_name',
+        :'n_publications' => :'n_publications',
+        :'n_member_orgs' => :'n_member_orgs',
+        :'best_match_tier' => :'best_match_tier',
+        :'first_pub_year' => :'first_pub_year',
+        :'last_pub_year' => :'last_pub_year',
+        :'supporting_pmids' => :'supporting_pmids',
+        :'supporting_pmids_truncated' => :'supporting_pmids_truncated',
+        :'n_papers_excluded_as_consortium' => :'n_papers_excluded_as_consortium'
       }
     end
 
@@ -52,20 +91,40 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'molecule_id' => :'String',
-        :'molecule_name' => :'String',
-        :'registered_as' => :'Array<String>',
-        :'matched_from_name_part' => :'Boolean',
-        :'brand_count' => :'Integer',
-        :'brands' => :'Array<ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInnerBrandsInner>'
+        :'route_key' => :'String',
+        :'gene_symbol' => :'String',
+        :'publisher_company_id' => :'String',
+        :'publisher_company_name' => :'String',
+        :'publisher_group_id' => :'String',
+        :'publisher_group_name' => :'String',
+        :'n_publications' => :'Integer',
+        :'n_member_orgs' => :'Integer',
+        :'best_match_tier' => :'String',
+        :'first_pub_year' => :'Integer',
+        :'last_pub_year' => :'Integer',
+        :'supporting_pmids' => :'Array<String>',
+        :'supporting_pmids_truncated' => :'Boolean',
+        :'n_papers_excluded_as_consortium' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'molecule_id',
-        :'molecule_name',
+        :'route_key',
+        :'gene_symbol',
+        :'publisher_company_id',
+        :'publisher_company_name',
+        :'publisher_group_id',
+        :'publisher_group_name',
+        :'n_publications',
+        :'n_member_orgs',
+        :'best_match_tier',
+        :'first_pub_year',
+        :'last_pub_year',
+        :'supporting_pmids',
+        :'supporting_pmids_truncated',
+        :'n_papers_excluded_as_consortium'
       ])
     end
 
@@ -73,132 +132,90 @@ module PharmaObservatory
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerPublishingCompaniesRow` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::BiomarkerPublishingCompaniesRow`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'molecule_id')
-        self.molecule_id = attributes[:'molecule_id']
-      else
-        self.molecule_id = nil
+      if attributes.key?(:'route_key')
+        self.route_key = attributes[:'route_key']
       end
 
-      if attributes.key?(:'molecule_name')
-        self.molecule_name = attributes[:'molecule_name']
-      else
-        self.molecule_name = nil
+      if attributes.key?(:'gene_symbol')
+        self.gene_symbol = attributes[:'gene_symbol']
       end
 
-      if attributes.key?(:'registered_as')
-        if (value = attributes[:'registered_as']).is_a?(Array)
-          self.registered_as = value
-        end
-      else
-        self.registered_as = nil
+      if attributes.key?(:'publisher_company_id')
+        self.publisher_company_id = attributes[:'publisher_company_id']
       end
 
-      if attributes.key?(:'matched_from_name_part')
-        self.matched_from_name_part = attributes[:'matched_from_name_part']
-      else
-        self.matched_from_name_part = nil
+      if attributes.key?(:'publisher_company_name')
+        self.publisher_company_name = attributes[:'publisher_company_name']
       end
 
-      if attributes.key?(:'brand_count')
-        self.brand_count = attributes[:'brand_count']
-      else
-        self.brand_count = nil
+      if attributes.key?(:'publisher_group_id')
+        self.publisher_group_id = attributes[:'publisher_group_id']
       end
 
-      if attributes.key?(:'brands')
-        if (value = attributes[:'brands']).is_a?(Array)
-          self.brands = value
-        end
-      else
-        self.brands = nil
+      if attributes.key?(:'publisher_group_name')
+        self.publisher_group_name = attributes[:'publisher_group_name']
       end
-    end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
-      invalid_properties = Array.new
-      if @registered_as.nil?
-        invalid_properties.push('invalid value for "registered_as", registered_as cannot be nil.')
+      if attributes.key?(:'n_publications')
+        self.n_publications = attributes[:'n_publications']
       end
 
-      if @matched_from_name_part.nil?
-        invalid_properties.push('invalid value for "matched_from_name_part", matched_from_name_part cannot be nil.')
+      if attributes.key?(:'n_member_orgs')
+        self.n_member_orgs = attributes[:'n_member_orgs']
       end
 
-      if @brand_count.nil?
-        invalid_properties.push('invalid value for "brand_count", brand_count cannot be nil.')
+      if attributes.key?(:'best_match_tier')
+        self.best_match_tier = attributes[:'best_match_tier']
       end
 
-      if @brands.nil?
-        invalid_properties.push('invalid value for "brands", brands cannot be nil.')
+      if attributes.key?(:'first_pub_year')
+        self.first_pub_year = attributes[:'first_pub_year']
       end
 
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @registered_as.nil?
-      return false if @matched_from_name_part.nil?
-      return false if @brand_count.nil?
-      return false if @brands.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] registered_as Value to be assigned
-    def registered_as=(registered_as)
-      if registered_as.nil?
-        fail ArgumentError, 'registered_as cannot be nil'
+      if attributes.key?(:'last_pub_year')
+        self.last_pub_year = attributes[:'last_pub_year']
       end
 
-      @registered_as = registered_as
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] matched_from_name_part Value to be assigned
-    def matched_from_name_part=(matched_from_name_part)
-      if matched_from_name_part.nil?
-        fail ArgumentError, 'matched_from_name_part cannot be nil'
+      if attributes.key?(:'supporting_pmids')
+        if (value = attributes[:'supporting_pmids']).is_a?(Array)
+          self.supporting_pmids = value
+        end
       end
 
-      @matched_from_name_part = matched_from_name_part
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] brand_count Value to be assigned
-    def brand_count=(brand_count)
-      if brand_count.nil?
-        fail ArgumentError, 'brand_count cannot be nil'
+      if attributes.key?(:'supporting_pmids_truncated')
+        self.supporting_pmids_truncated = attributes[:'supporting_pmids_truncated']
       end
 
-      @brand_count = brand_count
+      if attributes.key?(:'n_papers_excluded_as_consortium')
+        self.n_papers_excluded_as_consortium = attributes[:'n_papers_excluded_as_consortium']
+      end
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] brands Value to be assigned
-    def brands=(brands)
-      if brands.nil?
-        fail ArgumentError, 'brands cannot be nil'
-      end
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
 
-      @brands = brands
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -206,12 +223,20 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          molecule_id == o.molecule_id &&
-          molecule_name == o.molecule_name &&
-          registered_as == o.registered_as &&
-          matched_from_name_part == o.matched_from_name_part &&
-          brand_count == o.brand_count &&
-          brands == o.brands
+          route_key == o.route_key &&
+          gene_symbol == o.gene_symbol &&
+          publisher_company_id == o.publisher_company_id &&
+          publisher_company_name == o.publisher_company_name &&
+          publisher_group_id == o.publisher_group_id &&
+          publisher_group_name == o.publisher_group_name &&
+          n_publications == o.n_publications &&
+          n_member_orgs == o.n_member_orgs &&
+          best_match_tier == o.best_match_tier &&
+          first_pub_year == o.first_pub_year &&
+          last_pub_year == o.last_pub_year &&
+          supporting_pmids == o.supporting_pmids &&
+          supporting_pmids_truncated == o.supporting_pmids_truncated &&
+          n_papers_excluded_as_consortium == o.n_papers_excluded_as_consortium
     end
 
     # @see the `==` method
@@ -223,7 +248,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [molecule_id, molecule_name, registered_as, matched_from_name_part, brand_count, brands].hash
+      [route_key, gene_symbol, publisher_company_id, publisher_company_name, publisher_group_id, publisher_group_name, n_publications, n_member_orgs, best_match_tier, first_pub_year, last_pub_year, supporting_pmids, supporting_pmids_truncated, n_papers_excluded_as_consortium].hash
     end
 
     # Builds the object from hash