pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/sponsor_trial_start_forecast_row.rb

@@ -0,0 +1,509 @@
+=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_trial_start_forecast dataset: one row per organization record and target year. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SponsorTrialStartForecastRow
+    # Legal-entity level: the organization record the forecast series is for.
+    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 calendar year forecast.
+    attr_accessor :target_year
+
+    # Years ahead of the build year (0 is the current year).
+    attr_accessor :horizon_offset
+
+    # Months of the target year already observed.
+    attr_accessor :months_observed
+
+    # Months of the target year forecast.
+    attr_accessor :months_forecast
+
+    # Trials started in the target year up to the training cutoff.
+    attr_accessor :input_observed_through_cutoff
+
+    # Trials registered as planned to start in the rest of the target year.
+    attr_accessor :input_planned_remaining
+
+    # The forecast trial starts for the whole target year. A forecast of the eventual count, never an actual count, and it carries no interval.
+    attr_accessor :forecast_point
+
+    # The series' forecast status.
+    attr_accessor :forecast_status
+
+    # Trials the organization started in the last 60 months.
+    attr_accessor :input_trials_window_60m
+
+    # Average trial starts per year over the last 60 months.
+    attr_accessor :input_starts_per_year_60m
+
+    # The series size bucket the backtest error is measured in.
+    attr_accessor :size_bucket
+
+    # The horizon the backtest error was measured at.
+    attr_accessor :backtest_horizon
+
+    # Backtest symmetric mean absolute percentage error.
+    attr_accessor :backtest_smape_pct
+
+    # Backtest relative bias.
+    attr_accessor :backtest_rel_bias
+
+    # Backtest mean absolute error relative to the seasonal naive baseline.
+    attr_accessor :backtest_relmae_vs_snaive
+
+    # Series the backtest covered.
+    attr_accessor :backtest_n_series
+
+    # The backtest run reference.
+    attr_accessor :backtest_ref
+
+    # The forecasting model.
+    attr_accessor :model_name
+
+    # The model version.
+    attr_accessor :model_version
+
+    # The date the model's training data ends.
+    attr_accessor :training_cutoff
+
+    # How the forecast was produced.
+    attr_accessor :method
+
+    # 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',
+        :'target_year' => :'target_year',
+        :'horizon_offset' => :'horizon_offset',
+        :'months_observed' => :'months_observed',
+        :'months_forecast' => :'months_forecast',
+        :'input_observed_through_cutoff' => :'input_observed_through_cutoff',
+        :'input_planned_remaining' => :'input_planned_remaining',
+        :'forecast_point' => :'forecast_point',
+        :'forecast_status' => :'forecast_status',
+        :'input_trials_window_60m' => :'input_trials_window_60m',
+        :'input_starts_per_year_60m' => :'input_starts_per_year_60m',
+        :'size_bucket' => :'size_bucket',
+        :'backtest_horizon' => :'backtest_horizon',
+        :'backtest_smape_pct' => :'backtest_smape_pct',
+        :'backtest_rel_bias' => :'backtest_rel_bias',
+        :'backtest_relmae_vs_snaive' => :'backtest_relmae_vs_snaive',
+        :'backtest_n_series' => :'backtest_n_series',
+        :'backtest_ref' => :'backtest_ref',
+        :'model_name' => :'model_name',
+        :'model_version' => :'model_version',
+        :'training_cutoff' => :'training_cutoff',
+        :'method' => :'method'
+      }
+    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',
+        :'target_year' => :'Integer',
+        :'horizon_offset' => :'Integer',
+        :'months_observed' => :'Integer',
+        :'months_forecast' => :'Integer',
+        :'input_observed_through_cutoff' => :'Integer',
+        :'input_planned_remaining' => :'Integer',
+        :'forecast_point' => :'Float',
+        :'forecast_status' => :'String',
+        :'input_trials_window_60m' => :'Integer',
+        :'input_starts_per_year_60m' => :'Float',
+        :'size_bucket' => :'String',
+        :'backtest_horizon' => :'String',
+        :'backtest_smape_pct' => :'Float',
+        :'backtest_rel_bias' => :'Float',
+        :'backtest_relmae_vs_snaive' => :'Float',
+        :'backtest_n_series' => :'Integer',
+        :'backtest_ref' => :'String',
+        :'model_name' => :'String',
+        :'model_version' => :'String',
+        :'training_cutoff' => :'Date',
+        :'method' => :'String'
+      }
+    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',
+        :'target_year',
+        :'horizon_offset',
+        :'months_observed',
+        :'months_forecast',
+        :'input_observed_through_cutoff',
+        :'input_planned_remaining',
+        :'forecast_point',
+        :'forecast_status',
+        :'input_trials_window_60m',
+        :'input_starts_per_year_60m',
+        :'size_bucket',
+        :'backtest_horizon',
+        :'backtest_smape_pct',
+        :'backtest_rel_bias',
+        :'backtest_relmae_vs_snaive',
+        :'backtest_n_series',
+        :'backtest_ref',
+        :'model_name',
+        :'model_version',
+        :'training_cutoff',
+        :'method'
+      ])
+    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::SponsorTrialStartForecastRow` 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::SponsorTrialStartForecastRow`. 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?(:'target_year')
+        self.target_year = attributes[:'target_year']
+      end
+
+      if attributes.key?(:'horizon_offset')
+        self.horizon_offset = attributes[:'horizon_offset']
+      end
+
+      if attributes.key?(:'months_observed')
+        self.months_observed = attributes[:'months_observed']
+      end
+
+      if attributes.key?(:'months_forecast')
+        self.months_forecast = attributes[:'months_forecast']
+      end
+
+      if attributes.key?(:'input_observed_through_cutoff')
+        self.input_observed_through_cutoff = attributes[:'input_observed_through_cutoff']
+      end
+
+      if attributes.key?(:'input_planned_remaining')
+        self.input_planned_remaining = attributes[:'input_planned_remaining']
+      end
+
+      if attributes.key?(:'forecast_point')
+        self.forecast_point = attributes[:'forecast_point']
+      end
+
+      if attributes.key?(:'forecast_status')
+        self.forecast_status = attributes[:'forecast_status']
+      end
+
+      if attributes.key?(:'input_trials_window_60m')
+        self.input_trials_window_60m = attributes[:'input_trials_window_60m']
+      end
+
+      if attributes.key?(:'input_starts_per_year_60m')
+        self.input_starts_per_year_60m = attributes[:'input_starts_per_year_60m']
+      end
+
+      if attributes.key?(:'size_bucket')
+        self.size_bucket = attributes[:'size_bucket']
+      end
+
+      if attributes.key?(:'backtest_horizon')
+        self.backtest_horizon = attributes[:'backtest_horizon']
+      end
+
+      if attributes.key?(:'backtest_smape_pct')
+        self.backtest_smape_pct = attributes[:'backtest_smape_pct']
+      end
+
+      if attributes.key?(:'backtest_rel_bias')
+        self.backtest_rel_bias = attributes[:'backtest_rel_bias']
+      end
+
+      if attributes.key?(:'backtest_relmae_vs_snaive')
+        self.backtest_relmae_vs_snaive = attributes[:'backtest_relmae_vs_snaive']
+      end
+
+      if attributes.key?(:'backtest_n_series')
+        self.backtest_n_series = attributes[:'backtest_n_series']
+      end
+
+      if attributes.key?(:'backtest_ref')
+        self.backtest_ref = attributes[:'backtest_ref']
+      end
+
+      if attributes.key?(:'model_name')
+        self.model_name = attributes[:'model_name']
+      end
+
+      if attributes.key?(:'model_version')
+        self.model_version = attributes[:'model_version']
+      end
+
+      if attributes.key?(:'training_cutoff')
+        self.training_cutoff = attributes[:'training_cutoff']
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      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 &&
+          target_year == o.target_year &&
+          horizon_offset == o.horizon_offset &&
+          months_observed == o.months_observed &&
+          months_forecast == o.months_forecast &&
+          input_observed_through_cutoff == o.input_observed_through_cutoff &&
+          input_planned_remaining == o.input_planned_remaining &&
+          forecast_point == o.forecast_point &&
+          forecast_status == o.forecast_status &&
+          input_trials_window_60m == o.input_trials_window_60m &&
+          input_starts_per_year_60m == o.input_starts_per_year_60m &&
+          size_bucket == o.size_bucket &&
+          backtest_horizon == o.backtest_horizon &&
+          backtest_smape_pct == o.backtest_smape_pct &&
+          backtest_rel_bias == o.backtest_rel_bias &&
+          backtest_relmae_vs_snaive == o.backtest_relmae_vs_snaive &&
+          backtest_n_series == o.backtest_n_series &&
+          backtest_ref == o.backtest_ref &&
+          model_name == o.model_name &&
+          model_version == o.model_version &&
+          training_cutoff == o.training_cutoff &&
+          method == o.method
+    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, target_year, horizon_offset, months_observed, months_forecast, input_observed_through_cutoff, input_planned_remaining, forecast_point, forecast_status, input_trials_window_60m, input_starts_per_year_60m, size_bucket, backtest_horizon, backtest_smape_pct, backtest_rel_bias, backtest_relmae_vs_snaive, backtest_n_series, backtest_ref, model_name, model_version, training_cutoff, method].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