pharmaobservatory 0.1.7 → 0.1.9

data/lib/pharmaobservatory/models/company_competitors_row.rb

@@ -0,0 +1,493 @@
+=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_competitors dataset: one row per ordered company pair: a company and one of its top 25 competitors. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyCompetitorsRow
+    # 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 competing company.
+    attr_accessor :competitor_company_id
+
+    # Display name of the competitor's company.
+    attr_accessor :competitor_company_name
+
+    # Group level: the competitor's current ultimate parent; a root's group is itself.
+    attr_accessor :competitor_group_id
+
+    # Display name of the competitor's group.
+    attr_accessor :competitor_group_name
+
+    # The competitor's rank for the company by competitor_score (1 is the highest).
+    attr_accessor :competitor_rank
+
+    # 100 times the weighted mean of the four similarities below, rounded to four places.
+    attr_accessor :competitor_score
+
+    # Jaccard similarity, 0 to 1, of the two companies' molecular target sets.
+    attr_accessor :target_sim
+
+    # Jaccard similarity, 0 to 1, of their mechanism sets (a target and its action).
+    attr_accessor :mechanism_sim
+
+    # Jaccard similarity, 0 to 1, of their top-25 disease area sets.
+    attr_accessor :indication_sim
+
+    # The fraction, 0 to 1, of the shared targets that both companies have taken to phase 2 or later.
+    attr_accessor :phase_sim
+
+    # Molecular targets both companies pursue.
+    attr_accessor :n_shared_targets
+
+    # Mechanisms (target and action) both companies pursue.
+    attr_accessor :n_shared_mechanisms
+
+    # Disease areas both companies are in, within each one's top 25.
+    attr_accessor :n_shared_indications
+
+    # Shared targets that both companies have taken to phase 2 or later.
+    attr_accessor :n_phase_overlap_targets
+
+    # Targets the company pursues (the Jaccard denominator).
+    attr_accessor :n_company_targets
+
+    # Targets the competitor pursues.
+    attr_accessor :n_competitor_targets
+
+    # Disease areas in the company's top 25.
+    attr_accessor :n_company_indications
+
+    # Disease areas in the competitor's top 25.
+    attr_accessor :n_competitor_indications
+
+    # Up to 5 shared target gene symbols, by combined phase then combined trials. An empty list when none.
+    attr_accessor :top_shared_targets
+
+    # Up to 5 shared disease area names, by combined trial count. An empty list when none.
+    attr_accessor :top_shared_indications
+
+    # Up to 3 shared mechanisms written as a gene symbol and an action, by combined phase then combined trials. An empty list when none.
+    attr_accessor :top_shared_mechanisms
+
+    # 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',
+        :'competitor_company_id' => :'competitor_company_id',
+        :'competitor_company_name' => :'competitor_company_name',
+        :'competitor_group_id' => :'competitor_group_id',
+        :'competitor_group_name' => :'competitor_group_name',
+        :'competitor_rank' => :'competitor_rank',
+        :'competitor_score' => :'competitor_score',
+        :'target_sim' => :'target_sim',
+        :'mechanism_sim' => :'mechanism_sim',
+        :'indication_sim' => :'indication_sim',
+        :'phase_sim' => :'phase_sim',
+        :'n_shared_targets' => :'n_shared_targets',
+        :'n_shared_mechanisms' => :'n_shared_mechanisms',
+        :'n_shared_indications' => :'n_shared_indications',
+        :'n_phase_overlap_targets' => :'n_phase_overlap_targets',
+        :'n_company_targets' => :'n_company_targets',
+        :'n_competitor_targets' => :'n_competitor_targets',
+        :'n_company_indications' => :'n_company_indications',
+        :'n_competitor_indications' => :'n_competitor_indications',
+        :'top_shared_targets' => :'top_shared_targets',
+        :'top_shared_indications' => :'top_shared_indications',
+        :'top_shared_mechanisms' => :'top_shared_mechanisms'
+      }
+    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',
+        :'competitor_company_id' => :'String',
+        :'competitor_company_name' => :'String',
+        :'competitor_group_id' => :'String',
+        :'competitor_group_name' => :'String',
+        :'competitor_rank' => :'Integer',
+        :'competitor_score' => :'Float',
+        :'target_sim' => :'Float',
+        :'mechanism_sim' => :'Float',
+        :'indication_sim' => :'Float',
+        :'phase_sim' => :'Float',
+        :'n_shared_targets' => :'Integer',
+        :'n_shared_mechanisms' => :'Integer',
+        :'n_shared_indications' => :'Integer',
+        :'n_phase_overlap_targets' => :'Integer',
+        :'n_company_targets' => :'Integer',
+        :'n_competitor_targets' => :'Integer',
+        :'n_company_indications' => :'Integer',
+        :'n_competitor_indications' => :'Integer',
+        :'top_shared_targets' => :'Array<String>',
+        :'top_shared_indications' => :'Array<String>',
+        :'top_shared_mechanisms' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'competitor_company_id',
+        :'competitor_company_name',
+        :'competitor_group_id',
+        :'competitor_group_name',
+        :'competitor_rank',
+        :'competitor_score',
+        :'target_sim',
+        :'mechanism_sim',
+        :'indication_sim',
+        :'phase_sim',
+        :'n_shared_targets',
+        :'n_shared_mechanisms',
+        :'n_shared_indications',
+        :'n_phase_overlap_targets',
+        :'n_company_targets',
+        :'n_competitor_targets',
+        :'n_company_indications',
+        :'n_competitor_indications',
+        :'top_shared_targets',
+        :'top_shared_indications',
+        :'top_shared_mechanisms'
+      ])
+    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::CompanyCompetitorsRow` 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::CompanyCompetitorsRow`. 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?(:'competitor_company_id')
+        self.competitor_company_id = attributes[:'competitor_company_id']
+      end
+
+      if attributes.key?(:'competitor_company_name')
+        self.competitor_company_name = attributes[:'competitor_company_name']
+      end
+
+      if attributes.key?(:'competitor_group_id')
+        self.competitor_group_id = attributes[:'competitor_group_id']
+      end
+
+      if attributes.key?(:'competitor_group_name')
+        self.competitor_group_name = attributes[:'competitor_group_name']
+      end
+
+      if attributes.key?(:'competitor_rank')
+        self.competitor_rank = attributes[:'competitor_rank']
+      end
+
+      if attributes.key?(:'competitor_score')
+        self.competitor_score = attributes[:'competitor_score']
+      end
+
+      if attributes.key?(:'target_sim')
+        self.target_sim = attributes[:'target_sim']
+      end
+
+      if attributes.key?(:'mechanism_sim')
+        self.mechanism_sim = attributes[:'mechanism_sim']
+      end
+
+      if attributes.key?(:'indication_sim')
+        self.indication_sim = attributes[:'indication_sim']
+      end
+
+      if attributes.key?(:'phase_sim')
+        self.phase_sim = attributes[:'phase_sim']
+      end
+
+      if attributes.key?(:'n_shared_targets')
+        self.n_shared_targets = attributes[:'n_shared_targets']
+      end
+
+      if attributes.key?(:'n_shared_mechanisms')
+        self.n_shared_mechanisms = attributes[:'n_shared_mechanisms']
+      end
+
+      if attributes.key?(:'n_shared_indications')
+        self.n_shared_indications = attributes[:'n_shared_indications']
+      end
+
+      if attributes.key?(:'n_phase_overlap_targets')
+        self.n_phase_overlap_targets = attributes[:'n_phase_overlap_targets']
+      end
+
+      if attributes.key?(:'n_company_targets')
+        self.n_company_targets = attributes[:'n_company_targets']
+      end
+
+      if attributes.key?(:'n_competitor_targets')
+        self.n_competitor_targets = attributes[:'n_competitor_targets']
+      end
+
+      if attributes.key?(:'n_company_indications')
+        self.n_company_indications = attributes[:'n_company_indications']
+      end
+
+      if attributes.key?(:'n_competitor_indications')
+        self.n_competitor_indications = attributes[:'n_competitor_indications']
+      end
+
+      if attributes.key?(:'top_shared_targets')
+        if (value = attributes[:'top_shared_targets']).is_a?(Array)
+          self.top_shared_targets = value
+        end
+      end
+
+      if attributes.key?(:'top_shared_indications')
+        if (value = attributes[:'top_shared_indications']).is_a?(Array)
+          self.top_shared_indications = value
+        end
+      end
+
+      if attributes.key?(:'top_shared_mechanisms')
+        if (value = attributes[:'top_shared_mechanisms']).is_a?(Array)
+          self.top_shared_mechanisms = value
+        end
+      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 &&
+          competitor_company_id == o.competitor_company_id &&
+          competitor_company_name == o.competitor_company_name &&
+          competitor_group_id == o.competitor_group_id &&
+          competitor_group_name == o.competitor_group_name &&
+          competitor_rank == o.competitor_rank &&
+          competitor_score == o.competitor_score &&
+          target_sim == o.target_sim &&
+          mechanism_sim == o.mechanism_sim &&
+          indication_sim == o.indication_sim &&
+          phase_sim == o.phase_sim &&
+          n_shared_targets == o.n_shared_targets &&
+          n_shared_mechanisms == o.n_shared_mechanisms &&
+          n_shared_indications == o.n_shared_indications &&
+          n_phase_overlap_targets == o.n_phase_overlap_targets &&
+          n_company_targets == o.n_company_targets &&
+          n_competitor_targets == o.n_competitor_targets &&
+          n_company_indications == o.n_company_indications &&
+          n_competitor_indications == o.n_competitor_indications &&
+          top_shared_targets == o.top_shared_targets &&
+          top_shared_indications == o.top_shared_indications &&
+          top_shared_mechanisms == o.top_shared_mechanisms
+    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, competitor_company_id, competitor_company_name, competitor_group_id, competitor_group_name, competitor_rank, competitor_score, target_sim, mechanism_sim, indication_sim, phase_sim, n_shared_targets, n_shared_mechanisms, n_shared_indications, n_phase_overlap_targets, n_company_targets, n_competitor_targets, n_company_indications, n_competitor_indications, top_shared_targets, top_shared_indications, top_shared_mechanisms].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