pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/target_programs_row.rb

@@ -0,0 +1,447 @@
+=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 target_programs dataset: one row per target, drug and indication. A grouped request returns the group columns and the measures instead, as additional properties.
+  class TargetProgramsRow
+    # The target's Ensembl gene id (ENSG followed by eleven digits): the entry key for the targets object type. A gene symbol is not a value here; it is a separate column.
+    attr_accessor :target_id
+
+    # The target's HGNC gene symbol (the id the target page address carries).
+    attr_accessor :target_symbol
+
+    # The drug's canonical id (the same id the drug datasets use as drug_id).
+    attr_accessor :drug_id
+
+    # The drug's name.
+    attr_accessor :drug_name
+
+    # The condition as a MeSH descriptor id (D followed by digits), the id the conditions datasets use.
+    attr_accessor :condition_id
+
+    # The condition's name.
+    attr_accessor :condition_name
+
+    # The furthest phase the program reached, 0 to 4 (0 is phase not reported).
+    attr_accessor :max_phase
+
+    # Distinct trials of the drug in the indication.
+    attr_accessor :n_trials
+
+    # Of n_trials, those with status COMPLETED.
+    attr_accessor :n_completed
+
+    # Of n_trials, those with status TERMINATED.
+    attr_accessor :n_terminated_trials
+
+    # The earliest plausible trial start year.
+    attr_accessor :first_year
+
+    # The latest plausible trial completion or start year.
+    attr_accessor :last_year
+
+    # True when the program has a terminated, withdrawn or suspended trial.
+    attr_accessor :is_discontinued
+
+    # Distinct stopped trials (terminated, withdrawn or suspended); 0 for a live program.
+    attr_accessor :n_discontinued
+
+    # Of the stopped trials, those TERMINATED.
+    attr_accessor :n_terminated
+
+    # Of the stopped trials, those WITHDRAWN.
+    attr_accessor :n_withdrawn
+
+    # Of the stopped trials, those SUSPENDED.
+    attr_accessor :n_suspended
+
+    # The furthest phase among the stopped trials, 0 to 4; null for a live program.
+    attr_accessor :max_phase_at_stop
+
+    # The latest year a stopped trial ended; null for a live program.
+    attr_accessor :last_stop_year
+
+    # The stop reasons registrants disclosed, verbatim; empty when none.
+    attr_accessor :why_stopped_reasons
+
+    # The normalized stop-reason categories (efficacy_futility, safety, funding and so on); empty when none.
+    attr_accessor :why_stopped_categories
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'target_id' => :'target_id',
+        :'target_symbol' => :'target_symbol',
+        :'drug_id' => :'drug_id',
+        :'drug_name' => :'drug_name',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'max_phase' => :'max_phase',
+        :'n_trials' => :'n_trials',
+        :'n_completed' => :'n_completed',
+        :'n_terminated_trials' => :'n_terminated_trials',
+        :'first_year' => :'first_year',
+        :'last_year' => :'last_year',
+        :'is_discontinued' => :'is_discontinued',
+        :'n_discontinued' => :'n_discontinued',
+        :'n_terminated' => :'n_terminated',
+        :'n_withdrawn' => :'n_withdrawn',
+        :'n_suspended' => :'n_suspended',
+        :'max_phase_at_stop' => :'max_phase_at_stop',
+        :'last_stop_year' => :'last_stop_year',
+        :'why_stopped_reasons' => :'why_stopped_reasons',
+        :'why_stopped_categories' => :'why_stopped_categories'
+      }
+    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
+      {
+        :'target_id' => :'String',
+        :'target_symbol' => :'String',
+        :'drug_id' => :'String',
+        :'drug_name' => :'String',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'max_phase' => :'Integer',
+        :'n_trials' => :'Integer',
+        :'n_completed' => :'Integer',
+        :'n_terminated_trials' => :'Integer',
+        :'first_year' => :'Integer',
+        :'last_year' => :'Integer',
+        :'is_discontinued' => :'Boolean',
+        :'n_discontinued' => :'Integer',
+        :'n_terminated' => :'Integer',
+        :'n_withdrawn' => :'Integer',
+        :'n_suspended' => :'Integer',
+        :'max_phase_at_stop' => :'Integer',
+        :'last_stop_year' => :'Integer',
+        :'why_stopped_reasons' => :'Array<String>',
+        :'why_stopped_categories' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'target_id',
+        :'target_symbol',
+        :'drug_id',
+        :'drug_name',
+        :'condition_id',
+        :'condition_name',
+        :'max_phase',
+        :'n_trials',
+        :'n_completed',
+        :'n_terminated_trials',
+        :'first_year',
+        :'last_year',
+        :'is_discontinued',
+        :'n_discontinued',
+        :'n_terminated',
+        :'n_withdrawn',
+        :'n_suspended',
+        :'max_phase_at_stop',
+        :'last_stop_year',
+        :'why_stopped_reasons',
+        :'why_stopped_categories'
+      ])
+    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::TargetProgramsRow` 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::TargetProgramsRow`. 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?(:'target_id')
+        self.target_id = attributes[:'target_id']
+      end
+
+      if attributes.key?(:'target_symbol')
+        self.target_symbol = attributes[:'target_symbol']
+      end
+
+      if attributes.key?(:'drug_id')
+        self.drug_id = attributes[:'drug_id']
+      end
+
+      if attributes.key?(:'drug_name')
+        self.drug_name = attributes[:'drug_name']
+      end
+
+      if attributes.key?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
+      end
+
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
+      end
+
+      if attributes.key?(:'max_phase')
+        self.max_phase = attributes[:'max_phase']
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'n_completed')
+        self.n_completed = attributes[:'n_completed']
+      end
+
+      if attributes.key?(:'n_terminated_trials')
+        self.n_terminated_trials = attributes[:'n_terminated_trials']
+      end
+
+      if attributes.key?(:'first_year')
+        self.first_year = attributes[:'first_year']
+      end
+
+      if attributes.key?(:'last_year')
+        self.last_year = attributes[:'last_year']
+      end
+
+      if attributes.key?(:'is_discontinued')
+        self.is_discontinued = attributes[:'is_discontinued']
+      end
+
+      if attributes.key?(:'n_discontinued')
+        self.n_discontinued = attributes[:'n_discontinued']
+      end
+
+      if attributes.key?(:'n_terminated')
+        self.n_terminated = attributes[:'n_terminated']
+      end
+
+      if attributes.key?(:'n_withdrawn')
+        self.n_withdrawn = attributes[:'n_withdrawn']
+      end
+
+      if attributes.key?(:'n_suspended')
+        self.n_suspended = attributes[:'n_suspended']
+      end
+
+      if attributes.key?(:'max_phase_at_stop')
+        self.max_phase_at_stop = attributes[:'max_phase_at_stop']
+      end
+
+      if attributes.key?(:'last_stop_year')
+        self.last_stop_year = attributes[:'last_stop_year']
+      end
+
+      if attributes.key?(:'why_stopped_reasons')
+        if (value = attributes[:'why_stopped_reasons']).is_a?(Array)
+          self.why_stopped_reasons = value
+        end
+      end
+
+      if attributes.key?(:'why_stopped_categories')
+        if (value = attributes[:'why_stopped_categories']).is_a?(Array)
+          self.why_stopped_categories = 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 &&
+          target_id == o.target_id &&
+          target_symbol == o.target_symbol &&
+          drug_id == o.drug_id &&
+          drug_name == o.drug_name &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          max_phase == o.max_phase &&
+          n_trials == o.n_trials &&
+          n_completed == o.n_completed &&
+          n_terminated_trials == o.n_terminated_trials &&
+          first_year == o.first_year &&
+          last_year == o.last_year &&
+          is_discontinued == o.is_discontinued &&
+          n_discontinued == o.n_discontinued &&
+          n_terminated == o.n_terminated &&
+          n_withdrawn == o.n_withdrawn &&
+          n_suspended == o.n_suspended &&
+          max_phase_at_stop == o.max_phase_at_stop &&
+          last_stop_year == o.last_stop_year &&
+          why_stopped_reasons == o.why_stopped_reasons &&
+          why_stopped_categories == o.why_stopped_categories
+    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
+      [target_id, target_symbol, drug_id, drug_name, condition_id, condition_name, max_phase, n_trials, n_completed, n_terminated_trials, first_year, last_year, is_discontinued, n_discontinued, n_terminated, n_withdrawn, n_suspended, max_phase_at_stop, last_stop_year, why_stopped_reasons, why_stopped_categories].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