pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/sponsor_recruitment_by_phase_row.rb

@@ -0,0 +1,443 @@
+=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 sponsor_recruitment_by_phase dataset: one row per organization record and phase bucket. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SponsorRecruitmentByPhaseRow
+    # Legal-entity level: the organization record the series is for (the lead sponsor).
+    attr_accessor :sponsor_org_id
+
+    # Display name of the organization record.
+    attr_accessor :sponsor_name
+
+    # Company level: the company the organization belongs to (null when unresolved).
+    attr_accessor :sponsor_company_id
+
+    # Display name of the sponsor's company.
+    attr_accessor :sponsor_company_name
+
+    # Group level: the sponsor's current ultimate parent company; a root company's group is itself.
+    attr_accessor :sponsor_group_id
+
+    # Display name of the sponsor's group.
+    attr_accessor :sponsor_group_name
+
+    # The phase bucket of the trial (one vocabulary for predicted and realized rows).
+    attr_accessor :phase_bucket
+
+    # Per phase bucket, the same count as the series column of that name.
+    attr_accessor :n_predicted_open
+
+    # Per phase bucket, the same count as the series column of that name.
+    attr_accessor :n_predicted_at_cap
+
+    # Per phase bucket, the same count as the series column of that name.
+    attr_accessor :n_predicted_overdue
+
+    # Median over the bucket's rows; NULL under min_n.
+    attr_accessor :predicted_months_median
+
+    # Median over the bucket's rows; NULL under min_n.
+    attr_accessor :baseline_months_median
+
+    # Per phase bucket, the same count as the series column of that name.
+    attr_accessor :n_realized
+
+    # Median over the bucket's rows; NULL under min_n.
+    attr_accessor :realized_months_median
+
+    # Backtest mean absolute error in months for this phase bucket; NULL on an unmeasured bucket or one with no open predicted trial.
+    attr_accessor :error_phase_mae_months
+
+    # The model's mean absolute error (MAE) over the baseline's MAE in this phase bucket.
+    attr_accessor :error_phase_relmae_vs_baseline
+
+    # The baseline's mean absolute error (MAE) in months in this phase bucket.
+    attr_accessor :error_phase_baseline_mae_months
+
+    # Backtest trials behind the phase figure.
+    attr_accessor :error_phase_n_trials
+
+    # Backtest years behind the phase figure.
+    attr_accessor :error_phase_n_years
+
+    # The floor applied: a median is withheld below this many trials, carried so a reader sees the floor used.
+    attr_accessor :min_n
+
+    # The date the model's training data ends.
+    attr_accessor :training_cutoff
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sponsor_org_id' => :'sponsor_org_id',
+        :'sponsor_name' => :'sponsor_name',
+        :'sponsor_company_id' => :'sponsor_company_id',
+        :'sponsor_company_name' => :'sponsor_company_name',
+        :'sponsor_group_id' => :'sponsor_group_id',
+        :'sponsor_group_name' => :'sponsor_group_name',
+        :'phase_bucket' => :'phase_bucket',
+        :'n_predicted_open' => :'n_predicted_open',
+        :'n_predicted_at_cap' => :'n_predicted_at_cap',
+        :'n_predicted_overdue' => :'n_predicted_overdue',
+        :'predicted_months_median' => :'predicted_months_median',
+        :'baseline_months_median' => :'baseline_months_median',
+        :'n_realized' => :'n_realized',
+        :'realized_months_median' => :'realized_months_median',
+        :'error_phase_mae_months' => :'error_phase_mae_months',
+        :'error_phase_relmae_vs_baseline' => :'error_phase_relmae_vs_baseline',
+        :'error_phase_baseline_mae_months' => :'error_phase_baseline_mae_months',
+        :'error_phase_n_trials' => :'error_phase_n_trials',
+        :'error_phase_n_years' => :'error_phase_n_years',
+        :'min_n' => :'min_n',
+        :'training_cutoff' => :'training_cutoff'
+      }
+    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
+      {
+        :'sponsor_org_id' => :'String',
+        :'sponsor_name' => :'String',
+        :'sponsor_company_id' => :'String',
+        :'sponsor_company_name' => :'String',
+        :'sponsor_group_id' => :'String',
+        :'sponsor_group_name' => :'String',
+        :'phase_bucket' => :'String',
+        :'n_predicted_open' => :'Integer',
+        :'n_predicted_at_cap' => :'Integer',
+        :'n_predicted_overdue' => :'Integer',
+        :'predicted_months_median' => :'Float',
+        :'baseline_months_median' => :'Float',
+        :'n_realized' => :'Integer',
+        :'realized_months_median' => :'Float',
+        :'error_phase_mae_months' => :'Float',
+        :'error_phase_relmae_vs_baseline' => :'Float',
+        :'error_phase_baseline_mae_months' => :'Float',
+        :'error_phase_n_trials' => :'Integer',
+        :'error_phase_n_years' => :'Integer',
+        :'min_n' => :'Integer',
+        :'training_cutoff' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sponsor_org_id',
+        :'sponsor_name',
+        :'sponsor_company_id',
+        :'sponsor_company_name',
+        :'sponsor_group_id',
+        :'sponsor_group_name',
+        :'phase_bucket',
+        :'n_predicted_open',
+        :'n_predicted_at_cap',
+        :'n_predicted_overdue',
+        :'predicted_months_median',
+        :'baseline_months_median',
+        :'n_realized',
+        :'realized_months_median',
+        :'error_phase_mae_months',
+        :'error_phase_relmae_vs_baseline',
+        :'error_phase_baseline_mae_months',
+        :'error_phase_n_trials',
+        :'error_phase_n_years',
+        :'min_n',
+        :'training_cutoff'
+      ])
+    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::SponsorRecruitmentByPhaseRow` 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::SponsorRecruitmentByPhaseRow`. 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?(:'sponsor_org_id')
+        self.sponsor_org_id = attributes[:'sponsor_org_id']
+      end
+
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
+      end
+
+      if attributes.key?(:'sponsor_company_id')
+        self.sponsor_company_id = attributes[:'sponsor_company_id']
+      end
+
+      if attributes.key?(:'sponsor_company_name')
+        self.sponsor_company_name = attributes[:'sponsor_company_name']
+      end
+
+      if attributes.key?(:'sponsor_group_id')
+        self.sponsor_group_id = attributes[:'sponsor_group_id']
+      end
+
+      if attributes.key?(:'sponsor_group_name')
+        self.sponsor_group_name = attributes[:'sponsor_group_name']
+      end
+
+      if attributes.key?(:'phase_bucket')
+        self.phase_bucket = attributes[:'phase_bucket']
+      end
+
+      if attributes.key?(:'n_predicted_open')
+        self.n_predicted_open = attributes[:'n_predicted_open']
+      end
+
+      if attributes.key?(:'n_predicted_at_cap')
+        self.n_predicted_at_cap = attributes[:'n_predicted_at_cap']
+      end
+
+      if attributes.key?(:'n_predicted_overdue')
+        self.n_predicted_overdue = attributes[:'n_predicted_overdue']
+      end
+
+      if attributes.key?(:'predicted_months_median')
+        self.predicted_months_median = attributes[:'predicted_months_median']
+      end
+
+      if attributes.key?(:'baseline_months_median')
+        self.baseline_months_median = attributes[:'baseline_months_median']
+      end
+
+      if attributes.key?(:'n_realized')
+        self.n_realized = attributes[:'n_realized']
+      end
+
+      if attributes.key?(:'realized_months_median')
+        self.realized_months_median = attributes[:'realized_months_median']
+      end
+
+      if attributes.key?(:'error_phase_mae_months')
+        self.error_phase_mae_months = attributes[:'error_phase_mae_months']
+      end
+
+      if attributes.key?(:'error_phase_relmae_vs_baseline')
+        self.error_phase_relmae_vs_baseline = attributes[:'error_phase_relmae_vs_baseline']
+      end
+
+      if attributes.key?(:'error_phase_baseline_mae_months')
+        self.error_phase_baseline_mae_months = attributes[:'error_phase_baseline_mae_months']
+      end
+
+      if attributes.key?(:'error_phase_n_trials')
+        self.error_phase_n_trials = attributes[:'error_phase_n_trials']
+      end
+
+      if attributes.key?(:'error_phase_n_years')
+        self.error_phase_n_years = attributes[:'error_phase_n_years']
+      end
+
+      if attributes.key?(:'min_n')
+        self.min_n = attributes[:'min_n']
+      end
+
+      if attributes.key?(:'training_cutoff')
+        self.training_cutoff = attributes[:'training_cutoff']
+      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 &&
+          sponsor_org_id == o.sponsor_org_id &&
+          sponsor_name == o.sponsor_name &&
+          sponsor_company_id == o.sponsor_company_id &&
+          sponsor_company_name == o.sponsor_company_name &&
+          sponsor_group_id == o.sponsor_group_id &&
+          sponsor_group_name == o.sponsor_group_name &&
+          phase_bucket == o.phase_bucket &&
+          n_predicted_open == o.n_predicted_open &&
+          n_predicted_at_cap == o.n_predicted_at_cap &&
+          n_predicted_overdue == o.n_predicted_overdue &&
+          predicted_months_median == o.predicted_months_median &&
+          baseline_months_median == o.baseline_months_median &&
+          n_realized == o.n_realized &&
+          realized_months_median == o.realized_months_median &&
+          error_phase_mae_months == o.error_phase_mae_months &&
+          error_phase_relmae_vs_baseline == o.error_phase_relmae_vs_baseline &&
+          error_phase_baseline_mae_months == o.error_phase_baseline_mae_months &&
+          error_phase_n_trials == o.error_phase_n_trials &&
+          error_phase_n_years == o.error_phase_n_years &&
+          min_n == o.min_n &&
+          training_cutoff == o.training_cutoff
+    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
+      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, phase_bucket, n_predicted_open, n_predicted_at_cap, n_predicted_overdue, predicted_months_median, baseline_months_median, n_realized, realized_months_median, error_phase_mae_months, error_phase_relmae_vs_baseline, error_phase_baseline_mae_months, error_phase_n_trials, error_phase_n_years, min_n, training_cutoff].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