pharmaobservatory 0.1.7 → 0.1.8

data/lib/pharmaobservatory/models/rwd_conductor_delivery_row.rb

@@ -0,0 +1,537 @@
+=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 rwd_conductor_delivery dataset: one row per conductor and mandate stratum. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdConductorDeliveryRow
+    # The normalised institution name key the conductor rollup is keyed on; every register institution whose name folds to it is one conductor.
+    attr_accessor :conductor_name_key
+
+    # The conductor slug: the register's normalised institution name key with spaces as hyphens, the id in the web page address (/rwd-conductors/<id>). The entry key of the rwd_conductors object type; injective because no name key carries a hyphen.
+    attr_accessor :conductor_id
+
+    # The conductor's display name: one register spelling of the key.
+    attr_accessor :conductor_name
+
+    # Every register spelling of the key, as the study lists name it.
+    attr_accessor :conductor_names
+
+    # all (every study of the conductor), mandated (studies a regulator required) or voluntary (studies the registrant says it did not require); studies with an unknown mandate are in all only.
+    attr_accessor :mandate_stratum
+
+    # The register Institution IDs of every register row that folds to this conductor (more than one when the register lists the name twice).
+    attr_accessor :register_institution_ids
+
+    # How many register institution rows fold to this conductor; above one means the register lists the name more than once and the counts are per name, not per row.
+    attr_accessor :register_row_count
+
+    # The office country text the register institutions declare, one element per distinct declaration; the office is not where the conductor delivered studies (see rwd_conductor_footprint).
+    attr_accessor :declared_office_countries
+
+    # True when any register row of the conductor declares itself an ENCePP (European Network of Centres for Pharmacoepidemiology and Pharmacovigilance) partner.
+    attr_accessor :any_encepp_partner
+
+    # Distinct registered studies the conductor is named as conducting institution on. Not additive with additional_role_studies.
+    attr_accessor :lifetime_studies
+
+    # Conducting studies that started within five years of the snapshot.
+    attr_accessor :recent_studies
+
+    # Conducting studies whose status is Ongoing.
+    attr_accessor :ongoing_studies
+
+    # Distinct registered studies the conductor is named on as an additional institution; a different claim from conducting, never added to it.
+    attr_accessor :additional_role_studies
+
+    # Conducting studies a regulator required (mandate_stratum mandated).
+    attr_accessor :mandated_studies
+
+    # mandated_studies over lifetime_studies; null when the conductor has no conducting study.
+    attr_accessor :mandated_share
+
+    # Conducting studies with both a planned and an actual final report date.
+    attr_accessor :final_report_pairs
+
+    # Of those pairs, the studies whose planned and actual date are equal to the day (a likely backfill).
+    attr_accessor :backfilled_pairs
+
+    # Conducting studies with a final report slip (both dates present and different); the denominator of the delivery figures.
+    attr_accessor :comparable_pairs
+
+    # backfilled_pairs over final_report_pairs; null when there is no pair.
+    attr_accessor :backfilled_share
+
+    # The floor on comparable_pairs below which the median, quartiles and late count are null (suppressed, not zero).
+    attr_accessor :n_floor
+
+    # True when comparable_pairs reaches n_floor, so the slip figures are shown.
+    attr_accessor :meets_n_floor
+
+    # Median final report slip in days (positive is late) over the conductor's comparable pairs; null below the floor.
+    attr_accessor :median_slip_days
+
+    # First quartile of the final report slip in days; null below the floor.
+    attr_accessor :p25_slip_days
+
+    # Third quartile of the final report slip in days; null below the floor.
+    attr_accessor :p75_slip_days
+
+    # Comparable studies whose final report slipped more than 30 days; null below the floor.
+    attr_accessor :late_over_30d
+
+    # The label of the catalogue snapshot the row was read from (a date).
+    attr_accessor :snapshot_label
+
+    # The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL.
+    attr_accessor :accessed_month
+
+    # The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending).
+    attr_accessor :restriction_tier
+
+    # The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row.
+    attr_accessor :attribution
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'conductor_name_key' => :'conductor_name_key',
+        :'conductor_id' => :'conductor_id',
+        :'conductor_name' => :'conductor_name',
+        :'conductor_names' => :'conductor_names',
+        :'mandate_stratum' => :'mandate_stratum',
+        :'register_institution_ids' => :'register_institution_ids',
+        :'register_row_count' => :'register_row_count',
+        :'declared_office_countries' => :'declared_office_countries',
+        :'any_encepp_partner' => :'any_encepp_partner',
+        :'lifetime_studies' => :'lifetime_studies',
+        :'recent_studies' => :'recent_studies',
+        :'ongoing_studies' => :'ongoing_studies',
+        :'additional_role_studies' => :'additional_role_studies',
+        :'mandated_studies' => :'mandated_studies',
+        :'mandated_share' => :'mandated_share',
+        :'final_report_pairs' => :'final_report_pairs',
+        :'backfilled_pairs' => :'backfilled_pairs',
+        :'comparable_pairs' => :'comparable_pairs',
+        :'backfilled_share' => :'backfilled_share',
+        :'n_floor' => :'n_floor',
+        :'meets_n_floor' => :'meets_n_floor',
+        :'median_slip_days' => :'median_slip_days',
+        :'p25_slip_days' => :'p25_slip_days',
+        :'p75_slip_days' => :'p75_slip_days',
+        :'late_over_30d' => :'late_over_30d',
+        :'snapshot_label' => :'snapshot_label',
+        :'accessed_month' => :'accessed_month',
+        :'restriction_tier' => :'restriction_tier',
+        :'attribution' => :'attribution'
+      }
+    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
+      {
+        :'conductor_name_key' => :'String',
+        :'conductor_id' => :'String',
+        :'conductor_name' => :'String',
+        :'conductor_names' => :'Array<String>',
+        :'mandate_stratum' => :'String',
+        :'register_institution_ids' => :'Array<String>',
+        :'register_row_count' => :'Integer',
+        :'declared_office_countries' => :'Array<String>',
+        :'any_encepp_partner' => :'Boolean',
+        :'lifetime_studies' => :'Integer',
+        :'recent_studies' => :'Integer',
+        :'ongoing_studies' => :'Integer',
+        :'additional_role_studies' => :'Integer',
+        :'mandated_studies' => :'Integer',
+        :'mandated_share' => :'Float',
+        :'final_report_pairs' => :'Integer',
+        :'backfilled_pairs' => :'Integer',
+        :'comparable_pairs' => :'Integer',
+        :'backfilled_share' => :'Float',
+        :'n_floor' => :'Integer',
+        :'meets_n_floor' => :'Boolean',
+        :'median_slip_days' => :'Float',
+        :'p25_slip_days' => :'Float',
+        :'p75_slip_days' => :'Float',
+        :'late_over_30d' => :'Integer',
+        :'snapshot_label' => :'String',
+        :'accessed_month' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'conductor_name_key',
+        :'conductor_id',
+        :'conductor_name',
+        :'conductor_names',
+        :'mandate_stratum',
+        :'register_institution_ids',
+        :'register_row_count',
+        :'declared_office_countries',
+        :'any_encepp_partner',
+        :'lifetime_studies',
+        :'recent_studies',
+        :'ongoing_studies',
+        :'additional_role_studies',
+        :'mandated_studies',
+        :'mandated_share',
+        :'final_report_pairs',
+        :'backfilled_pairs',
+        :'comparable_pairs',
+        :'backfilled_share',
+        :'n_floor',
+        :'meets_n_floor',
+        :'median_slip_days',
+        :'p25_slip_days',
+        :'p75_slip_days',
+        :'late_over_30d',
+        :'snapshot_label',
+        :'accessed_month',
+        :'restriction_tier',
+        :'attribution'
+      ])
+    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::RwdConductorDeliveryRow` 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::RwdConductorDeliveryRow`. 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?(:'conductor_name_key')
+        self.conductor_name_key = attributes[:'conductor_name_key']
+      end
+
+      if attributes.key?(:'conductor_id')
+        self.conductor_id = attributes[:'conductor_id']
+      end
+
+      if attributes.key?(:'conductor_name')
+        self.conductor_name = attributes[:'conductor_name']
+      end
+
+      if attributes.key?(:'conductor_names')
+        if (value = attributes[:'conductor_names']).is_a?(Array)
+          self.conductor_names = value
+        end
+      end
+
+      if attributes.key?(:'mandate_stratum')
+        self.mandate_stratum = attributes[:'mandate_stratum']
+      end
+
+      if attributes.key?(:'register_institution_ids')
+        if (value = attributes[:'register_institution_ids']).is_a?(Array)
+          self.register_institution_ids = value
+        end
+      end
+
+      if attributes.key?(:'register_row_count')
+        self.register_row_count = attributes[:'register_row_count']
+      end
+
+      if attributes.key?(:'declared_office_countries')
+        if (value = attributes[:'declared_office_countries']).is_a?(Array)
+          self.declared_office_countries = value
+        end
+      end
+
+      if attributes.key?(:'any_encepp_partner')
+        self.any_encepp_partner = attributes[:'any_encepp_partner']
+      end
+
+      if attributes.key?(:'lifetime_studies')
+        self.lifetime_studies = attributes[:'lifetime_studies']
+      end
+
+      if attributes.key?(:'recent_studies')
+        self.recent_studies = attributes[:'recent_studies']
+      end
+
+      if attributes.key?(:'ongoing_studies')
+        self.ongoing_studies = attributes[:'ongoing_studies']
+      end
+
+      if attributes.key?(:'additional_role_studies')
+        self.additional_role_studies = attributes[:'additional_role_studies']
+      end
+
+      if attributes.key?(:'mandated_studies')
+        self.mandated_studies = attributes[:'mandated_studies']
+      end
+
+      if attributes.key?(:'mandated_share')
+        self.mandated_share = attributes[:'mandated_share']
+      end
+
+      if attributes.key?(:'final_report_pairs')
+        self.final_report_pairs = attributes[:'final_report_pairs']
+      end
+
+      if attributes.key?(:'backfilled_pairs')
+        self.backfilled_pairs = attributes[:'backfilled_pairs']
+      end
+
+      if attributes.key?(:'comparable_pairs')
+        self.comparable_pairs = attributes[:'comparable_pairs']
+      end
+
+      if attributes.key?(:'backfilled_share')
+        self.backfilled_share = attributes[:'backfilled_share']
+      end
+
+      if attributes.key?(:'n_floor')
+        self.n_floor = attributes[:'n_floor']
+      end
+
+      if attributes.key?(:'meets_n_floor')
+        self.meets_n_floor = attributes[:'meets_n_floor']
+      end
+
+      if attributes.key?(:'median_slip_days')
+        self.median_slip_days = attributes[:'median_slip_days']
+      end
+
+      if attributes.key?(:'p25_slip_days')
+        self.p25_slip_days = attributes[:'p25_slip_days']
+      end
+
+      if attributes.key?(:'p75_slip_days')
+        self.p75_slip_days = attributes[:'p75_slip_days']
+      end
+
+      if attributes.key?(:'late_over_30d')
+        self.late_over_30d = attributes[:'late_over_30d']
+      end
+
+      if attributes.key?(:'snapshot_label')
+        self.snapshot_label = attributes[:'snapshot_label']
+      end
+
+      if attributes.key?(:'accessed_month')
+        self.accessed_month = attributes[:'accessed_month']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      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 &&
+          conductor_name_key == o.conductor_name_key &&
+          conductor_id == o.conductor_id &&
+          conductor_name == o.conductor_name &&
+          conductor_names == o.conductor_names &&
+          mandate_stratum == o.mandate_stratum &&
+          register_institution_ids == o.register_institution_ids &&
+          register_row_count == o.register_row_count &&
+          declared_office_countries == o.declared_office_countries &&
+          any_encepp_partner == o.any_encepp_partner &&
+          lifetime_studies == o.lifetime_studies &&
+          recent_studies == o.recent_studies &&
+          ongoing_studies == o.ongoing_studies &&
+          additional_role_studies == o.additional_role_studies &&
+          mandated_studies == o.mandated_studies &&
+          mandated_share == o.mandated_share &&
+          final_report_pairs == o.final_report_pairs &&
+          backfilled_pairs == o.backfilled_pairs &&
+          comparable_pairs == o.comparable_pairs &&
+          backfilled_share == o.backfilled_share &&
+          n_floor == o.n_floor &&
+          meets_n_floor == o.meets_n_floor &&
+          median_slip_days == o.median_slip_days &&
+          p25_slip_days == o.p25_slip_days &&
+          p75_slip_days == o.p75_slip_days &&
+          late_over_30d == o.late_over_30d &&
+          snapshot_label == o.snapshot_label &&
+          accessed_month == o.accessed_month &&
+          restriction_tier == o.restriction_tier &&
+          attribution == o.attribution
+    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
+      [conductor_name_key, conductor_id, conductor_name, conductor_names, mandate_stratum, register_institution_ids, register_row_count, declared_office_countries, any_encepp_partner, lifetime_studies, recent_studies, ongoing_studies, additional_role_studies, mandated_studies, mandated_share, final_report_pairs, backfilled_pairs, comparable_pairs, backfilled_share, n_floor, meets_n_floor, median_slip_days, p25_slip_days, p75_slip_days, late_over_30d, snapshot_label, accessed_month, restriction_tier, attribution].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