pharmaobservatory 0.1.12 → 0.1.13

data/lib/pharmaobservatory/models/company_peer_profile_row.rb

@@ -0,0 +1,454 @@
+=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_peer_profile dataset: one row per industry company with at least one program row. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyPeerProfileRow
+    # 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
+
+    # measured when the company has at least one peer; no_live_owned_program when it has no live owned program; phase_not_reported when its live owned programs carry no phase; no_candidates when stage and modality are known and no other company shares them.
+    attr_accessor :peer_state
+
+    # Distinct live owned (drug, condition) programs of the company's subtree.
+    attr_accessor :n_live_owned_programs
+
+    # Distinct live owned drugs of the company's subtree.
+    attr_accessor :n_live_owned_drugs
+
+    # Furthest phase of the live owned programs: approved, phase3, phase2 (Phase 2/3 included), phase1 (Phase 1/2 included) or early_phase1. Null when no program carries a phase.
+    attr_accessor :lead_stage
+
+    # The phase code behind lead_stage: 6 Phase 4 or approved, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early Phase 1.
+    attr_accessor :lead_max_phase
+
+    # The canonical drug id of the lead drug, the highest-phase live owned drug (ties: most trials, then drug id).
+    attr_accessor :lead_drug_id
+
+    # Name of the lead drug.
+    attr_accessor :lead_drug_name
+
+    # Live owned drugs whose GSRS substance type is protein or nucleic acid.
+    attr_accessor :n_biologic_drugs
+
+    # n_biologic_drugs over n_live_owned_drugs, 0 to 1. Null when the company has no live owned drug.
+    attr_accessor :biologic_share
+
+    # biologic when biologic_share is at least 0.5, else non_biologic.
+    attr_accessor :modality_band
+
+    # MeSH top-level category with the most live owned program trials.
+    attr_accessor :primary_area
+
+    # Live owned program trials in primary_area.
+    attr_accessor :primary_area_trials
+
+    # Distinct lead-sponsored trials of the company's subtree.
+    attr_accessor :num_lead_trials
+
+    # Band of num_lead_trials: 1-4, 5-19, 20-99 or 100+.
+    attr_accessor :size_band
+
+    # Other measured companies outside the company's group that share stage, modality, area and size (match level 1), before the top 10 are kept.
+    attr_accessor :n_cell_candidates
+
+    # Peer rows kept for the company, at most 10.
+    attr_accessor :n_peers
+
+    # Companies in this dataset with peer_state measured. The same value on every row.
+    attr_accessor :coverage_measured
+
+    # Companies in this dataset. The same value on every row.
+    attr_accessor :coverage_total
+
+    # 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_state' => :'peer_state',
+        :'n_live_owned_programs' => :'n_live_owned_programs',
+        :'n_live_owned_drugs' => :'n_live_owned_drugs',
+        :'lead_stage' => :'lead_stage',
+        :'lead_max_phase' => :'lead_max_phase',
+        :'lead_drug_id' => :'lead_drug_id',
+        :'lead_drug_name' => :'lead_drug_name',
+        :'n_biologic_drugs' => :'n_biologic_drugs',
+        :'biologic_share' => :'biologic_share',
+        :'modality_band' => :'modality_band',
+        :'primary_area' => :'primary_area',
+        :'primary_area_trials' => :'primary_area_trials',
+        :'num_lead_trials' => :'num_lead_trials',
+        :'size_band' => :'size_band',
+        :'n_cell_candidates' => :'n_cell_candidates',
+        :'n_peers' => :'n_peers',
+        :'coverage_measured' => :'coverage_measured',
+        :'coverage_total' => :'coverage_total'
+      }
+    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_state' => :'String',
+        :'n_live_owned_programs' => :'Integer',
+        :'n_live_owned_drugs' => :'Integer',
+        :'lead_stage' => :'String',
+        :'lead_max_phase' => :'Integer',
+        :'lead_drug_id' => :'String',
+        :'lead_drug_name' => :'String',
+        :'n_biologic_drugs' => :'Integer',
+        :'biologic_share' => :'Float',
+        :'modality_band' => :'String',
+        :'primary_area' => :'String',
+        :'primary_area_trials' => :'Integer',
+        :'num_lead_trials' => :'Integer',
+        :'size_band' => :'String',
+        :'n_cell_candidates' => :'Integer',
+        :'n_peers' => :'Integer',
+        :'coverage_measured' => :'Integer',
+        :'coverage_total' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'peer_state',
+        :'n_live_owned_programs',
+        :'n_live_owned_drugs',
+        :'lead_stage',
+        :'lead_max_phase',
+        :'lead_drug_id',
+        :'lead_drug_name',
+        :'n_biologic_drugs',
+        :'biologic_share',
+        :'modality_band',
+        :'primary_area',
+        :'primary_area_trials',
+        :'num_lead_trials',
+        :'size_band',
+        :'n_cell_candidates',
+        :'n_peers',
+        :'coverage_measured',
+        :'coverage_total'
+      ])
+    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::CompanyPeerProfileRow` 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::CompanyPeerProfileRow`. 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_state')
+        self.peer_state = attributes[:'peer_state']
+      end
+
+      if attributes.key?(:'n_live_owned_programs')
+        self.n_live_owned_programs = attributes[:'n_live_owned_programs']
+      end
+
+      if attributes.key?(:'n_live_owned_drugs')
+        self.n_live_owned_drugs = attributes[:'n_live_owned_drugs']
+      end
+
+      if attributes.key?(:'lead_stage')
+        self.lead_stage = attributes[:'lead_stage']
+      end
+
+      if attributes.key?(:'lead_max_phase')
+        self.lead_max_phase = attributes[:'lead_max_phase']
+      end
+
+      if attributes.key?(:'lead_drug_id')
+        self.lead_drug_id = attributes[:'lead_drug_id']
+      end
+
+      if attributes.key?(:'lead_drug_name')
+        self.lead_drug_name = attributes[:'lead_drug_name']
+      end
+
+      if attributes.key?(:'n_biologic_drugs')
+        self.n_biologic_drugs = attributes[:'n_biologic_drugs']
+      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?(:'primary_area_trials')
+        self.primary_area_trials = attributes[:'primary_area_trials']
+      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
+
+      if attributes.key?(:'n_cell_candidates')
+        self.n_cell_candidates = attributes[:'n_cell_candidates']
+      end
+
+      if attributes.key?(:'n_peers')
+        self.n_peers = attributes[:'n_peers']
+      end
+
+      if attributes.key?(:'coverage_measured')
+        self.coverage_measured = attributes[:'coverage_measured']
+      end
+
+      if attributes.key?(:'coverage_total')
+        self.coverage_total = attributes[:'coverage_total']
+      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_state == o.peer_state &&
+          n_live_owned_programs == o.n_live_owned_programs &&
+          n_live_owned_drugs == o.n_live_owned_drugs &&
+          lead_stage == o.lead_stage &&
+          lead_max_phase == o.lead_max_phase &&
+          lead_drug_id == o.lead_drug_id &&
+          lead_drug_name == o.lead_drug_name &&
+          n_biologic_drugs == o.n_biologic_drugs &&
+          biologic_share == o.biologic_share &&
+          modality_band == o.modality_band &&
+          primary_area == o.primary_area &&
+          primary_area_trials == o.primary_area_trials &&
+          num_lead_trials == o.num_lead_trials &&
+          size_band == o.size_band &&
+          n_cell_candidates == o.n_cell_candidates &&
+          n_peers == o.n_peers &&
+          coverage_measured == o.coverage_measured &&
+          coverage_total == o.coverage_total
+    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_state, n_live_owned_programs, n_live_owned_drugs, lead_stage, lead_max_phase, lead_drug_id, lead_drug_name, n_biologic_drugs, biologic_share, modality_band, primary_area, primary_area_trials, num_lead_trials, size_band, n_cell_candidates, n_peers, coverage_measured, coverage_total].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