pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/trial_extracted_endpoints_row.rb

@@ -0,0 +1,346 @@
+=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 trial_extracted_endpoints dataset: one row per trial with an extracted primary-endpoint reading. A grouped request returns the group columns and the measures instead, as additional properties.
+  class TrialExtractedEndpointsRow
+    # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
+    attr_accessor :trial_id
+
+    # Whether the extraction found a formal primary-endpoint result.
+    attr_accessor :result_reported
+
+    # The extracted reading, verbatim: met, missed, mixed, reported_indeterminate or not_reported.
+    attr_accessor :signal
+
+    # The signal grouped as met, missed, mixed or unclear.
+    attr_accessor :outcome_category
+
+    # Whether outcome_category is met, missed or mixed.
+    attr_accessor :has_clean_outcome
+
+    # The primary endpoint descriptions the extraction found.
+    attr_accessor :primary_endpoints
+
+    # Number of primary endpoints extracted.
+    attr_accessor :primary_endpoint_count
+
+    # The extraction's confidence, from 0 to 1.
+    attr_accessor :confidence
+
+    # The text quoted as evidence for the reading.
+    attr_accessor :evidence_quote
+
+    # The registry page the reading was taken from.
+    attr_accessor :source_url
+
+    # The model that produced the reading.
+    attr_accessor :model
+
+    # When the extraction ran.
+    attr_accessor :extracted_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trial_id' => :'trial_id',
+        :'result_reported' => :'result_reported',
+        :'signal' => :'signal',
+        :'outcome_category' => :'outcome_category',
+        :'has_clean_outcome' => :'has_clean_outcome',
+        :'primary_endpoints' => :'primary_endpoints',
+        :'primary_endpoint_count' => :'primary_endpoint_count',
+        :'confidence' => :'confidence',
+        :'evidence_quote' => :'evidence_quote',
+        :'source_url' => :'source_url',
+        :'model' => :'model',
+        :'extracted_at' => :'extracted_at'
+      }
+    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
+      {
+        :'trial_id' => :'String',
+        :'result_reported' => :'Boolean',
+        :'signal' => :'String',
+        :'outcome_category' => :'String',
+        :'has_clean_outcome' => :'Boolean',
+        :'primary_endpoints' => :'Array<String>',
+        :'primary_endpoint_count' => :'Integer',
+        :'confidence' => :'Float',
+        :'evidence_quote' => :'String',
+        :'source_url' => :'String',
+        :'model' => :'String',
+        :'extracted_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'trial_id',
+        :'result_reported',
+        :'signal',
+        :'outcome_category',
+        :'has_clean_outcome',
+        :'primary_endpoints',
+        :'primary_endpoint_count',
+        :'confidence',
+        :'evidence_quote',
+        :'source_url',
+        :'model',
+        :'extracted_at'
+      ])
+    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::TrialExtractedEndpointsRow` 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::TrialExtractedEndpointsRow`. 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?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
+      end
+
+      if attributes.key?(:'result_reported')
+        self.result_reported = attributes[:'result_reported']
+      end
+
+      if attributes.key?(:'signal')
+        self.signal = attributes[:'signal']
+      end
+
+      if attributes.key?(:'outcome_category')
+        self.outcome_category = attributes[:'outcome_category']
+      end
+
+      if attributes.key?(:'has_clean_outcome')
+        self.has_clean_outcome = attributes[:'has_clean_outcome']
+      end
+
+      if attributes.key?(:'primary_endpoints')
+        if (value = attributes[:'primary_endpoints']).is_a?(Array)
+          self.primary_endpoints = value
+        end
+      end
+
+      if attributes.key?(:'primary_endpoint_count')
+        self.primary_endpoint_count = attributes[:'primary_endpoint_count']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'evidence_quote')
+        self.evidence_quote = attributes[:'evidence_quote']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'extracted_at')
+        self.extracted_at = attributes[:'extracted_at']
+      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 &&
+          trial_id == o.trial_id &&
+          result_reported == o.result_reported &&
+          signal == o.signal &&
+          outcome_category == o.outcome_category &&
+          has_clean_outcome == o.has_clean_outcome &&
+          primary_endpoints == o.primary_endpoints &&
+          primary_endpoint_count == o.primary_endpoint_count &&
+          confidence == o.confidence &&
+          evidence_quote == o.evidence_quote &&
+          source_url == o.source_url &&
+          model == o.model &&
+          extracted_at == o.extracted_at
+    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
+      [trial_id, result_reported, signal, outcome_category, has_clean_outcome, primary_endpoints, primary_endpoint_count, confidence, evidence_quote, source_url, model, extracted_at].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