pharmaobservatory 0.1.11 → 0.1.13

data/lib/pharmaobservatory/models/company_peers_row.rb

@@ -0,0 +1,421 @@
+=begin
+#Pharma Observatory Public REST API
+
+#Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PharmaObservatory
+  # One row of the company_peers dataset: one row per ordered company pair: an industry company and one of its top 10 peers by the match ladder. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyPeersRow
+    # Company level: the company the row is about; the entry key for the companies object type.
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # Company level: the peer company.
+    attr_accessor :peer_company_id
+
+    # Display name of the peer company.
+    attr_accessor :peer_company_name
+
+    # Group level: the peer's current ultimate parent; a root's group is itself.
+    attr_accessor :peer_group_id
+
+    # Display name of the peer's group.
+    attr_accessor :peer_group_name
+
+    # The peer's rank for the company, 1 is the closest match: match_level first, then the closeness of lead-trial counts, then of biologic share. Dense 1 to N.
+    attr_accessor :peer_rank
+
+    # What the peer matched the company on. 1 stage, modality, area and size; 2 stage, modality and area; 3 stage, modality and size; 4 stage and modality. Stage and modality always match.
+    attr_accessor :match_level
+
+    # True when the peer shares the company's primary therapeutic area.
+    attr_accessor :matched_area
+
+    # True when the peer shares the company's size band.
+    attr_accessor :matched_size
+
+    # The peer's lead stage, the furthest phase of its live owned programs. Equal to the company's lead stage on every row.
+    attr_accessor :lead_stage
+
+    # The peer's lead drug, the highest-phase live owned drug (ties: most trials).
+    attr_accessor :lead_drug_name
+
+    # Share, 0 to 1, of the peer's live owned drugs that are biologic (GSRS protein or nucleic acid substance type).
+    attr_accessor :biologic_share
+
+    # biologic when biologic_share is at least 0.5, else non_biologic. Equal to the company's band on every row.
+    attr_accessor :modality_band
+
+    # The peer's primary therapeutic area: the MeSH top-level category with the most live owned program trials.
+    attr_accessor :primary_area
+
+    # Distinct lead-sponsored trials of the peer's subtree.
+    attr_accessor :num_lead_trials
+
+    # Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+.
+    attr_accessor :size_band
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'peer_company_id' => :'peer_company_id',
+        :'peer_company_name' => :'peer_company_name',
+        :'peer_group_id' => :'peer_group_id',
+        :'peer_group_name' => :'peer_group_name',
+        :'peer_rank' => :'peer_rank',
+        :'match_level' => :'match_level',
+        :'matched_area' => :'matched_area',
+        :'matched_size' => :'matched_size',
+        :'lead_stage' => :'lead_stage',
+        :'lead_drug_name' => :'lead_drug_name',
+        :'biologic_share' => :'biologic_share',
+        :'modality_band' => :'modality_band',
+        :'primary_area' => :'primary_area',
+        :'num_lead_trials' => :'num_lead_trials',
+        :'size_band' => :'size_band'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'peer_company_id' => :'String',
+        :'peer_company_name' => :'String',
+        :'peer_group_id' => :'String',
+        :'peer_group_name' => :'String',
+        :'peer_rank' => :'Integer',
+        :'match_level' => :'Integer',
+        :'matched_area' => :'Boolean',
+        :'matched_size' => :'Boolean',
+        :'lead_stage' => :'String',
+        :'lead_drug_name' => :'String',
+        :'biologic_share' => :'Float',
+        :'modality_band' => :'String',
+        :'primary_area' => :'String',
+        :'num_lead_trials' => :'Integer',
+        :'size_band' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'peer_company_id',
+        :'peer_company_name',
+        :'peer_group_id',
+        :'peer_group_name',
+        :'peer_rank',
+        :'match_level',
+        :'matched_area',
+        :'matched_size',
+        :'lead_stage',
+        :'lead_drug_name',
+        :'biologic_share',
+        :'modality_band',
+        :'primary_area',
+        :'num_lead_trials',
+        :'size_band'
+      ])
+    end
+
+    # Initializes the object
+    # @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::CompanyPeersRow` 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::CompanyPeersRow`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'peer_company_id')
+        self.peer_company_id = attributes[:'peer_company_id']
+      end
+
+      if attributes.key?(:'peer_company_name')
+        self.peer_company_name = attributes[:'peer_company_name']
+      end
+
+      if attributes.key?(:'peer_group_id')
+        self.peer_group_id = attributes[:'peer_group_id']
+      end
+
+      if attributes.key?(:'peer_group_name')
+        self.peer_group_name = attributes[:'peer_group_name']
+      end
+
+      if attributes.key?(:'peer_rank')
+        self.peer_rank = attributes[:'peer_rank']
+      end
+
+      if attributes.key?(:'match_level')
+        self.match_level = attributes[:'match_level']
+      end
+
+      if attributes.key?(:'matched_area')
+        self.matched_area = attributes[:'matched_area']
+      end
+
+      if attributes.key?(:'matched_size')
+        self.matched_size = attributes[:'matched_size']
+      end
+
+      if attributes.key?(:'lead_stage')
+        self.lead_stage = attributes[:'lead_stage']
+      end
+
+      if attributes.key?(:'lead_drug_name')
+        self.lead_drug_name = attributes[:'lead_drug_name']
+      end
+
+      if attributes.key?(:'biologic_share')
+        self.biologic_share = attributes[:'biologic_share']
+      end
+
+      if attributes.key?(:'modality_band')
+        self.modality_band = attributes[:'modality_band']
+      end
+
+      if attributes.key?(:'primary_area')
+        self.primary_area = attributes[:'primary_area']
+      end
+
+      if attributes.key?(:'num_lead_trials')
+        self.num_lead_trials = attributes[:'num_lead_trials']
+      end
+
+      if attributes.key?(:'size_band')
+        self.size_band = attributes[:'size_band']
+      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
+      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'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          peer_company_id == o.peer_company_id &&
+          peer_company_name == o.peer_company_name &&
+          peer_group_id == o.peer_group_id &&
+          peer_group_name == o.peer_group_name &&
+          peer_rank == o.peer_rank &&
+          match_level == o.match_level &&
+          matched_area == o.matched_area &&
+          matched_size == o.matched_size &&
+          lead_stage == o.lead_stage &&
+          lead_drug_name == o.lead_drug_name &&
+          biologic_share == o.biologic_share &&
+          modality_band == o.modality_band &&
+          primary_area == o.primary_area &&
+          num_lead_trials == o.num_lead_trials &&
+          size_band == o.size_band
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [company_id, company_name, group_id, group_name, peer_company_id, peer_company_name, peer_group_id, peer_group_name, peer_rank, match_level, matched_area, matched_size, lead_stage, lead_drug_name, biologic_share, modality_band, primary_area, num_lead_trials, size_band].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PharmaObservatory.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/pharmaobservatory/models/company_programs_row.rb

@@ -64,6 +64,12 @@ module PharmaObservatory
     # approved, active or abandoned.
     attr_accessor :lifecycle
 
+    # True when the sponsor is judged to develop the drug (an experimental arm, a regulatory holder, or an inferred lead); false when it is the backbone or comparator of a combination, one of many leads of a crowded drug, or not the holder of a generic. Every row is kept; this column labels it.
+    attr_accessor :owned
+
+    # Why owned is what it is: experimental_arm, regulatory_holder or inferred_lead (owned), or backbone, comparator, crowded_not_lead or generic_not_holder (not owned). inferred_lead is an inference made where the trials give no arm evidence either way.
+    attr_accessor :ownership_basis
+
     # Disability-adjusted life years (DALYs, millions) of the condition's global burden, from the Global Burden of Disease (GBD) 2021 study of the Institute for Health Metrics and Evaluation (IHME). Null for a caller without the licence for this column; see withheld_columns.
     attr_accessor :dalys_millions
 
@@ -86,6 +92,8 @@ module PharmaObservatory
         :'last_year' => :'last_year',
         :'withdrawn' => :'withdrawn',
         :'lifecycle' => :'lifecycle',
+        :'owned' => :'owned',
+        :'ownership_basis' => :'ownership_basis',
         :'dalys_millions' => :'dalys_millions'
       }
     end
@@ -119,6 +127,8 @@ module PharmaObservatory
         :'last_year' => :'Integer',
         :'withdrawn' => :'Boolean',
         :'lifecycle' => :'String',
+        :'owned' => :'Boolean',
+        :'ownership_basis' => :'String',
         :'dalys_millions' => :'Float'
       }
     end
@@ -142,6 +152,8 @@ module PharmaObservatory
         :'last_year',
         :'withdrawn',
         :'lifecycle',
+        :'owned',
+        :'ownership_basis',
         :'dalys_millions'
       ])
     end
@@ -226,6 +238,14 @@ module PharmaObservatory
         self.lifecycle = attributes[:'lifecycle']
       end
 
+      if attributes.key?(:'owned')
+        self.owned = attributes[:'owned']
+      end
+
+      if attributes.key?(:'ownership_basis')
+        self.ownership_basis = attributes[:'ownership_basis']
+      end
+
       if attributes.key?(:'dalys_millions')
         self.dalys_millions = attributes[:'dalys_millions']
       end
@@ -267,6 +287,8 @@ module PharmaObservatory
           last_year == o.last_year &&
           withdrawn == o.withdrawn &&
           lifecycle == o.lifecycle &&
+          owned == o.owned &&
+          ownership_basis == o.ownership_basis &&
           dalys_millions == o.dalys_millions
     end
 
@@ -279,7 +301,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, drug_id, drug_name, condition_id, condition_name, max_phase, n_trials, n_active, last_year, withdrawn, lifecycle, dalys_millions].hash
+      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, drug_id, drug_name, condition_id, condition_name, max_phase, n_trials, n_active, last_year, withdrawn, lifecycle, owned, ownership_basis, dalys_millions].hash
     end
 
     # Builds the object from hash