pharmaobservatory 0.1.13 → 0.1.15

data/lib/pharmaobservatory/models/company_asset_collisions_row.rb

@@ -0,0 +1,502 @@
+=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_asset_collisions dataset: one row per company asset, competitor asset and target family: a live, owned asset of the company and one of another company on a common target family. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyAssetCollisionsRow
+    # 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
+
+    # Molecule level: the company's asset, the resolved drug (a drug with two canonical ids is one asset).
+    attr_accessor :molecule_id
+
+    # The asset's display name, from the company's most-trialled record of it.
+    attr_accessor :molecule_name
+
+    # Company level: the company whose asset collides.
+    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
+
+    # Molecule level: the competitor's asset, the resolved drug.
+    attr_accessor :competitor_molecule_id
+
+    # The competitor asset's display name.
+    attr_accessor :competitor_molecule_name
+
+    # The company drug's target family of the shared gene (the Open Targets target name, so a taxane's tubulin isotypes are one family; the ChEMBL mechanism text for a drug Open Targets lacks; the gene symbol for a curated investigational asset).
+    attr_accessor :target_family
+
+    # Gene symbols of the shared genes within the family.
+    attr_accessor :shared_symbols
+
+    # The company drug's action on the family (Open Targets or ChEMBL vocabulary); null when no source states one.
+    attr_accessor :action_type
+
+    # The competitor drug's action on the shared genes; null when no source states one.
+    attr_accessor :competitor_action_type
+
+    # True when the two drugs have the same action type on a shared gene of the family.
+    attr_accessor :same_action
+
+    # Disease areas both programs are in, among live programs.
+    attr_accessor :n_shared_indications
+
+    # Up to 3 shared disease area names, by the pair's combined trial count. An empty list when none.
+    attr_accessor :top_shared_indications
+
+    # The less advanced of the two programs' furthest phase: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1, -1 phase not applicable.
+    attr_accessor :stage
+
+    # The later of the two programs' last trial start year.
+    attr_accessor :last_year
+
+    # Trials led by either company in which one drug is experimental and the other an active comparator.
+    attr_accessor :n_head_to_head_trials
+
+    # Why the company owns the drug. experimental_arm and regulatory_holder rest on evidence; inferred_lead is an inference (no arm data says otherwise).
+    attr_accessor :ownership_basis
+
+    # Why the competitor owns its drug, same vocabulary as ownership_basis.
+    attr_accessor :competitor_ownership_basis
+
+    # The rarity weight of the family: the natural log of (companies holding any live, owned target family) over (companies holding this one).
+    attr_accessor :family_idf
+
+    # The weight of the pair, family_idf times a factor for same action, a shared indication, the stage, recency and a head-to-head trial.
+    attr_accessor :collision_weight
+
+    # 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',
+        :'molecule_id' => :'molecule_id',
+        :'molecule_name' => :'molecule_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_molecule_id' => :'competitor_molecule_id',
+        :'competitor_molecule_name' => :'competitor_molecule_name',
+        :'target_family' => :'target_family',
+        :'shared_symbols' => :'shared_symbols',
+        :'action_type' => :'action_type',
+        :'competitor_action_type' => :'competitor_action_type',
+        :'same_action' => :'same_action',
+        :'n_shared_indications' => :'n_shared_indications',
+        :'top_shared_indications' => :'top_shared_indications',
+        :'stage' => :'stage',
+        :'last_year' => :'last_year',
+        :'n_head_to_head_trials' => :'n_head_to_head_trials',
+        :'ownership_basis' => :'ownership_basis',
+        :'competitor_ownership_basis' => :'competitor_ownership_basis',
+        :'family_idf' => :'family_idf',
+        :'collision_weight' => :'collision_weight'
+      }
+    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',
+        :'molecule_id' => :'String',
+        :'molecule_name' => :'String',
+        :'competitor_company_id' => :'String',
+        :'competitor_company_name' => :'String',
+        :'competitor_group_id' => :'String',
+        :'competitor_group_name' => :'String',
+        :'competitor_molecule_id' => :'String',
+        :'competitor_molecule_name' => :'String',
+        :'target_family' => :'String',
+        :'shared_symbols' => :'Array<String>',
+        :'action_type' => :'String',
+        :'competitor_action_type' => :'String',
+        :'same_action' => :'Boolean',
+        :'n_shared_indications' => :'Integer',
+        :'top_shared_indications' => :'Array<String>',
+        :'stage' => :'Integer',
+        :'last_year' => :'Integer',
+        :'n_head_to_head_trials' => :'Integer',
+        :'ownership_basis' => :'String',
+        :'competitor_ownership_basis' => :'String',
+        :'family_idf' => :'Float',
+        :'collision_weight' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'molecule_id',
+        :'molecule_name',
+        :'competitor_company_id',
+        :'competitor_company_name',
+        :'competitor_group_id',
+        :'competitor_group_name',
+        :'competitor_molecule_id',
+        :'competitor_molecule_name',
+        :'target_family',
+        :'shared_symbols',
+        :'action_type',
+        :'competitor_action_type',
+        :'same_action',
+        :'n_shared_indications',
+        :'top_shared_indications',
+        :'stage',
+        :'last_year',
+        :'n_head_to_head_trials',
+        :'ownership_basis',
+        :'competitor_ownership_basis',
+        :'family_idf',
+        :'collision_weight'
+      ])
+    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::CompanyAssetCollisionsRow` 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::CompanyAssetCollisionsRow`. 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?(:'molecule_id')
+        self.molecule_id = attributes[:'molecule_id']
+      end
+
+      if attributes.key?(:'molecule_name')
+        self.molecule_name = attributes[:'molecule_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_molecule_id')
+        self.competitor_molecule_id = attributes[:'competitor_molecule_id']
+      end
+
+      if attributes.key?(:'competitor_molecule_name')
+        self.competitor_molecule_name = attributes[:'competitor_molecule_name']
+      end
+
+      if attributes.key?(:'target_family')
+        self.target_family = attributes[:'target_family']
+      end
+
+      if attributes.key?(:'shared_symbols')
+        if (value = attributes[:'shared_symbols']).is_a?(Array)
+          self.shared_symbols = value
+        end
+      end
+
+      if attributes.key?(:'action_type')
+        self.action_type = attributes[:'action_type']
+      end
+
+      if attributes.key?(:'competitor_action_type')
+        self.competitor_action_type = attributes[:'competitor_action_type']
+      end
+
+      if attributes.key?(:'same_action')
+        self.same_action = attributes[:'same_action']
+      end
+
+      if attributes.key?(:'n_shared_indications')
+        self.n_shared_indications = attributes[:'n_shared_indications']
+      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?(:'stage')
+        self.stage = attributes[:'stage']
+      end
+
+      if attributes.key?(:'last_year')
+        self.last_year = attributes[:'last_year']
+      end
+
+      if attributes.key?(:'n_head_to_head_trials')
+        self.n_head_to_head_trials = attributes[:'n_head_to_head_trials']
+      end
+
+      if attributes.key?(:'ownership_basis')
+        self.ownership_basis = attributes[:'ownership_basis']
+      end
+
+      if attributes.key?(:'competitor_ownership_basis')
+        self.competitor_ownership_basis = attributes[:'competitor_ownership_basis']
+      end
+
+      if attributes.key?(:'family_idf')
+        self.family_idf = attributes[:'family_idf']
+      end
+
+      if attributes.key?(:'collision_weight')
+        self.collision_weight = attributes[:'collision_weight']
+      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 &&
+          molecule_id == o.molecule_id &&
+          molecule_name == o.molecule_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_molecule_id == o.competitor_molecule_id &&
+          competitor_molecule_name == o.competitor_molecule_name &&
+          target_family == o.target_family &&
+          shared_symbols == o.shared_symbols &&
+          action_type == o.action_type &&
+          competitor_action_type == o.competitor_action_type &&
+          same_action == o.same_action &&
+          n_shared_indications == o.n_shared_indications &&
+          top_shared_indications == o.top_shared_indications &&
+          stage == o.stage &&
+          last_year == o.last_year &&
+          n_head_to_head_trials == o.n_head_to_head_trials &&
+          ownership_basis == o.ownership_basis &&
+          competitor_ownership_basis == o.competitor_ownership_basis &&
+          family_idf == o.family_idf &&
+          collision_weight == o.collision_weight
+    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, molecule_id, molecule_name, competitor_company_id, competitor_company_name, competitor_group_id, competitor_group_name, competitor_molecule_id, competitor_molecule_name, target_family, shared_symbols, action_type, competitor_action_type, same_action, n_shared_indications, top_shared_indications, stage, last_year, n_head_to_head_trials, ownership_basis, competitor_ownership_basis, family_idf, collision_weight].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