pharmaobservatory 0.1.6 → 0.1.8

data/lib/pharmaobservatory/models/rare_disease_investigator_coverage_row.rb

@@ -0,0 +1,333 @@
+=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 rare_disease_investigator_coverage dataset: one row per rare disease concept, unconditionally. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RareDiseaseInvestigatorCoverageRow
+    # The ORPHA code of the disease, the digits in the web page address (/rare-diseases/558). The entry key of the rare_diseases object type.
+    attr_accessor :orpha_code
+
+    # no_exact_mapping, no_direct_trials, no_publishable_investigator or computed.
+    attr_accessor :coverage_state
+
+    # Exact direct trials of the disease.
+    attr_accessor :n_direct_trials
+
+    # Those trials that name a principal investigator.
+    attr_accessor :n_direct_trials_with_named_pi
+
+    # Trial and principal investigator pairs among them.
+    attr_accessor :n_pi_trial_edges
+
+    # Distinct people named as principal investigator.
+    attr_accessor :n_pi_people
+
+    # Rows of rare_disease_investigators for the disease.
+    attr_accessor :n_investigators
+
+    # Investigators whose name another investigator of the disease shares.
+    attr_accessor :n_name_ambiguous
+
+    # The registry's latest update date the snapshot reflects.
+    attr_accessor :registry_reference_date
+
+    # The licence of the Orphadata Science release the disease list rests on.
+    attr_accessor :license_name
+
+    # The attribution line the source requires; 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
+      {
+        :'orpha_code' => :'orpha_code',
+        :'coverage_state' => :'coverage_state',
+        :'n_direct_trials' => :'n_direct_trials',
+        :'n_direct_trials_with_named_pi' => :'n_direct_trials_with_named_pi',
+        :'n_pi_trial_edges' => :'n_pi_trial_edges',
+        :'n_pi_people' => :'n_pi_people',
+        :'n_investigators' => :'n_investigators',
+        :'n_name_ambiguous' => :'n_name_ambiguous',
+        :'registry_reference_date' => :'registry_reference_date',
+        :'license_name' => :'license_name',
+        :'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
+      {
+        :'orpha_code' => :'String',
+        :'coverage_state' => :'String',
+        :'n_direct_trials' => :'Integer',
+        :'n_direct_trials_with_named_pi' => :'Integer',
+        :'n_pi_trial_edges' => :'Integer',
+        :'n_pi_people' => :'Integer',
+        :'n_investigators' => :'Integer',
+        :'n_name_ambiguous' => :'Integer',
+        :'registry_reference_date' => :'Date',
+        :'license_name' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'orpha_code',
+        :'coverage_state',
+        :'n_direct_trials',
+        :'n_direct_trials_with_named_pi',
+        :'n_pi_trial_edges',
+        :'n_pi_people',
+        :'n_investigators',
+        :'n_name_ambiguous',
+        :'registry_reference_date',
+        :'license_name',
+        :'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::RareDiseaseInvestigatorCoverageRow` 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::RareDiseaseInvestigatorCoverageRow`. 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?(:'orpha_code')
+        self.orpha_code = attributes[:'orpha_code']
+      end
+
+      if attributes.key?(:'coverage_state')
+        self.coverage_state = attributes[:'coverage_state']
+      end
+
+      if attributes.key?(:'n_direct_trials')
+        self.n_direct_trials = attributes[:'n_direct_trials']
+      end
+
+      if attributes.key?(:'n_direct_trials_with_named_pi')
+        self.n_direct_trials_with_named_pi = attributes[:'n_direct_trials_with_named_pi']
+      end
+
+      if attributes.key?(:'n_pi_trial_edges')
+        self.n_pi_trial_edges = attributes[:'n_pi_trial_edges']
+      end
+
+      if attributes.key?(:'n_pi_people')
+        self.n_pi_people = attributes[:'n_pi_people']
+      end
+
+      if attributes.key?(:'n_investigators')
+        self.n_investigators = attributes[:'n_investigators']
+      end
+
+      if attributes.key?(:'n_name_ambiguous')
+        self.n_name_ambiguous = attributes[:'n_name_ambiguous']
+      end
+
+      if attributes.key?(:'registry_reference_date')
+        self.registry_reference_date = attributes[:'registry_reference_date']
+      end
+
+      if attributes.key?(:'license_name')
+        self.license_name = attributes[:'license_name']
+      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 &&
+          orpha_code == o.orpha_code &&
+          coverage_state == o.coverage_state &&
+          n_direct_trials == o.n_direct_trials &&
+          n_direct_trials_with_named_pi == o.n_direct_trials_with_named_pi &&
+          n_pi_trial_edges == o.n_pi_trial_edges &&
+          n_pi_people == o.n_pi_people &&
+          n_investigators == o.n_investigators &&
+          n_name_ambiguous == o.n_name_ambiguous &&
+          registry_reference_date == o.registry_reference_date &&
+          license_name == o.license_name &&
+          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
+      [orpha_code, coverage_state, n_direct_trials, n_direct_trials_with_named_pi, n_pi_trial_edges, n_pi_people, n_investigators, n_name_ambiguous, registry_reference_date, license_name, 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