pharmaobservatory 0.1.3 → 0.1.5

data/lib/pharmaobservatory/models/trial_enrollment_rate_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 trial_enrollment_rate dataset: one row per trial. A grouped request returns the group columns and the measures instead, as additional properties.
+  class TrialEnrollmentRateRow
+    # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
+    attr_accessor :trial_id
+
+    # The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those.
+    attr_accessor :phase
+
+    # The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code.
+    attr_accessor :phase_label
+
+    # The lead sponsor name as filed.
+    attr_accessor :lead_sponsor_name
+
+    # A coarse status label (Completed and so on).
+    attr_accessor :overall_status_summary
+
+    # Enrollment typed ACTUAL.
+    attr_accessor :actual_enrollment
+
+    # ACTUAL or ESTIMATED.
+    attr_accessor :enrollment_type
+
+    # False when the registered enrollment is a placeholder value rather than a count.
+    attr_accessor :enrollment_is_plausible
+
+    # Number of sites the rate is computed over.
+    attr_accessor :active_sites
+
+    # Number of countries with a listed site.
+    attr_accessor :facility_country_count
+
+    # Whether any listed site is in the United States.
+    attr_accessor :has_us_facility
+
+    # Trial start date.
+    attr_accessor :start_date
+
+    # Primary completion date.
+    attr_accessor :primary_completion_date
+
+    # Completion date.
+    attr_accessor :completion_date
+
+    # ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED.
+    attr_accessor :primary_completion_date_type
+
+    # ACTUAL (a date that has occurred) or ESTIMATED (a planned date). The registry's older ANTICIPATED is published as ESTIMATED.
+    attr_accessor :completion_date_type
+
+    # Whether the inputs support a rate.
+    attr_accessor :is_rate_computable
+
+    # Why a rate could not be computed (null when it could).
+    attr_accessor :rate_flag_reason
+
+    # Months from start to primary completion.
+    attr_accessor :duration_months
+
+    # Months from start to completion.
+    attr_accessor :duration_months_overall
+
+    # Participants enrolled per month.
+    attr_accessor :pts_per_month
+
+    # Participants enrolled per site per month.
+    attr_accessor :pts_per_site_month
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trial_id' => :'trial_id',
+        :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
+        :'lead_sponsor_name' => :'lead_sponsor_name',
+        :'overall_status_summary' => :'overall_status_summary',
+        :'actual_enrollment' => :'actual_enrollment',
+        :'enrollment_type' => :'enrollment_type',
+        :'enrollment_is_plausible' => :'enrollment_is_plausible',
+        :'active_sites' => :'active_sites',
+        :'facility_country_count' => :'facility_country_count',
+        :'has_us_facility' => :'has_us_facility',
+        :'start_date' => :'start_date',
+        :'primary_completion_date' => :'primary_completion_date',
+        :'completion_date' => :'completion_date',
+        :'primary_completion_date_type' => :'primary_completion_date_type',
+        :'completion_date_type' => :'completion_date_type',
+        :'is_rate_computable' => :'is_rate_computable',
+        :'rate_flag_reason' => :'rate_flag_reason',
+        :'duration_months' => :'duration_months',
+        :'duration_months_overall' => :'duration_months_overall',
+        :'pts_per_month' => :'pts_per_month',
+        :'pts_per_site_month' => :'pts_per_site_month'
+      }
+    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',
+        :'phase' => :'String',
+        :'phase_label' => :'String',
+        :'lead_sponsor_name' => :'String',
+        :'overall_status_summary' => :'String',
+        :'actual_enrollment' => :'Integer',
+        :'enrollment_type' => :'String',
+        :'enrollment_is_plausible' => :'Boolean',
+        :'active_sites' => :'Integer',
+        :'facility_country_count' => :'Integer',
+        :'has_us_facility' => :'Boolean',
+        :'start_date' => :'Date',
+        :'primary_completion_date' => :'Date',
+        :'completion_date' => :'Date',
+        :'primary_completion_date_type' => :'String',
+        :'completion_date_type' => :'String',
+        :'is_rate_computable' => :'Boolean',
+        :'rate_flag_reason' => :'String',
+        :'duration_months' => :'Float',
+        :'duration_months_overall' => :'Float',
+        :'pts_per_month' => :'Float',
+        :'pts_per_site_month' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'trial_id',
+        :'phase',
+        :'phase_label',
+        :'lead_sponsor_name',
+        :'overall_status_summary',
+        :'actual_enrollment',
+        :'enrollment_type',
+        :'enrollment_is_plausible',
+        :'active_sites',
+        :'facility_country_count',
+        :'has_us_facility',
+        :'start_date',
+        :'primary_completion_date',
+        :'completion_date',
+        :'primary_completion_date_type',
+        :'completion_date_type',
+        :'is_rate_computable',
+        :'rate_flag_reason',
+        :'duration_months',
+        :'duration_months_overall',
+        :'pts_per_month',
+        :'pts_per_site_month'
+      ])
+    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::TrialEnrollmentRateRow` 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::TrialEnrollmentRateRow`. 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?(:'phase')
+        self.phase = attributes[:'phase']
+      end
+
+      if attributes.key?(:'phase_label')
+        self.phase_label = attributes[:'phase_label']
+      end
+
+      if attributes.key?(:'lead_sponsor_name')
+        self.lead_sponsor_name = attributes[:'lead_sponsor_name']
+      end
+
+      if attributes.key?(:'overall_status_summary')
+        self.overall_status_summary = attributes[:'overall_status_summary']
+      end
+
+      if attributes.key?(:'actual_enrollment')
+        self.actual_enrollment = attributes[:'actual_enrollment']
+      end
+
+      if attributes.key?(:'enrollment_type')
+        self.enrollment_type = attributes[:'enrollment_type']
+      end
+
+      if attributes.key?(:'enrollment_is_plausible')
+        self.enrollment_is_plausible = attributes[:'enrollment_is_plausible']
+      end
+
+      if attributes.key?(:'active_sites')
+        self.active_sites = attributes[:'active_sites']
+      end
+
+      if attributes.key?(:'facility_country_count')
+        self.facility_country_count = attributes[:'facility_country_count']
+      end
+
+      if attributes.key?(:'has_us_facility')
+        self.has_us_facility = attributes[:'has_us_facility']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'primary_completion_date')
+        self.primary_completion_date = attributes[:'primary_completion_date']
+      end
+
+      if attributes.key?(:'completion_date')
+        self.completion_date = attributes[:'completion_date']
+      end
+
+      if attributes.key?(:'primary_completion_date_type')
+        self.primary_completion_date_type = attributes[:'primary_completion_date_type']
+      end
+
+      if attributes.key?(:'completion_date_type')
+        self.completion_date_type = attributes[:'completion_date_type']
+      end
+
+      if attributes.key?(:'is_rate_computable')
+        self.is_rate_computable = attributes[:'is_rate_computable']
+      end
+
+      if attributes.key?(:'rate_flag_reason')
+        self.rate_flag_reason = attributes[:'rate_flag_reason']
+      end
+
+      if attributes.key?(:'duration_months')
+        self.duration_months = attributes[:'duration_months']
+      end
+
+      if attributes.key?(:'duration_months_overall')
+        self.duration_months_overall = attributes[:'duration_months_overall']
+      end
+
+      if attributes.key?(:'pts_per_month')
+        self.pts_per_month = attributes[:'pts_per_month']
+      end
+
+      if attributes.key?(:'pts_per_site_month')
+        self.pts_per_site_month = attributes[:'pts_per_site_month']
+      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 &&
+          phase == o.phase &&
+          phase_label == o.phase_label &&
+          lead_sponsor_name == o.lead_sponsor_name &&
+          overall_status_summary == o.overall_status_summary &&
+          actual_enrollment == o.actual_enrollment &&
+          enrollment_type == o.enrollment_type &&
+          enrollment_is_plausible == o.enrollment_is_plausible &&
+          active_sites == o.active_sites &&
+          facility_country_count == o.facility_country_count &&
+          has_us_facility == o.has_us_facility &&
+          start_date == o.start_date &&
+          primary_completion_date == o.primary_completion_date &&
+          completion_date == o.completion_date &&
+          primary_completion_date_type == o.primary_completion_date_type &&
+          completion_date_type == o.completion_date_type &&
+          is_rate_computable == o.is_rate_computable &&
+          rate_flag_reason == o.rate_flag_reason &&
+          duration_months == o.duration_months &&
+          duration_months_overall == o.duration_months_overall &&
+          pts_per_month == o.pts_per_month &&
+          pts_per_site_month == o.pts_per_site_month
+    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, phase, phase_label, lead_sponsor_name, overall_status_summary, actual_enrollment, enrollment_type, enrollment_is_plausible, active_sites, facility_country_count, has_us_facility, start_date, primary_completion_date, completion_date, primary_completion_date_type, completion_date_type, is_rate_computable, rate_flag_reason, duration_months, duration_months_overall, pts_per_month, pts_per_site_month].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