pharmaobservatory 0.1.12 → 0.1.13

data/lib/pharmaobservatory/models/company_cosponsors_row.rb

@@ -0,0 +1,445 @@
+=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 company_cosponsors dataset: one row per company and co-sponsor, at the root level (the co-sponsor's ultimate parent) and at the member level (a company under that root). A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyCosponsorsRow
+    # Company level: the company the row is about; the entry key for the companies object type.
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # root: the co-sponsor's ultimate parent company, with the distinct trials any company of that root shares with this company. member: a company under that root that itself co-sponsored, with its own count. Filter on one level; the two do not add.
+    attr_accessor :row_level
+
+    # Company level: the co-sponsoring company. At row_level root this is the root company; at member it is the member company itself.
+    attr_accessor :cosponsor_company_id
+
+    # Display name of the co-sponsoring company.
+    attr_accessor :cosponsor_company_name
+
+    # Group level: the co-sponsor's current ultimate parent; a root's group is itself.
+    attr_accessor :cosponsor_group_id
+
+    # Display name of the co-sponsor's group.
+    attr_accessor :cosponsor_group_name
+
+    # The ultimate parent company of the co-sponsor, the ladder company's `coalesce(ultimate_parent_company_id, company_id)`. Equal to cosponsor_company_id at row_level root, and the root a member row sits under.
+    attr_accessor :cosponsor_root_id
+
+    # The rank of the ROOT among this company's co-sponsor roots by distinct shared trials (1 is the most; ties broken by root id). The same on a root row and on each of its member rows.
+    attr_accessor :cosponsor_rank
+
+    # 0 on a root row; 1 and up on the member rows of that root, by the member's own shared trials. Order by cosponsor_rank then member_rank to list each root followed by its members.
+    attr_accessor :member_rank
+
+    # Member companies of this root that co-sponsored with this company, before the member cut. The same on a root row and its member rows.
+    attr_accessor :n_members
+
+    # Distinct co-sponsor roots for this company before the top-25 cut; the same on every row of a company.
+    attr_accessor :n_candidates
+
+    # Distinct trials that name both. At row_level root, the distinct trials of any company under the root (never a sum over members); at member, that company's own trials.
+    attr_accessor :n_shared_trials
+
+    # Of the shared trials, those where an organization record of this company holds the ClinicalTrials.gov lead sponsor role. At most n_shared_trials; it may overlap n_trials_cosponsor_lead.
+    attr_accessor :n_trials_company_lead
+
+    # Of the shared trials, those where the co-sponsor's organization record holds the lead sponsor role. At most n_shared_trials.
+    attr_accessor :n_trials_cosponsor_lead
+
+    # The earliest registered start year over the shared trials; null when none has a plausible year.
+    attr_accessor :first_shared_start_year
+
+    # The latest registered start year over the shared trials; null when none has a plausible year.
+    attr_accessor :last_shared_start_year
+
+    # Distinct specific MeSH disease areas over the shared trials.
+    attr_accessor :n_shared_conditions
+
+    # Up to 5 MeSH disease names by shared-trial count then name. An empty list when none.
+    attr_accessor :top_shared_conditions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'row_level' => :'row_level',
+        :'cosponsor_company_id' => :'cosponsor_company_id',
+        :'cosponsor_company_name' => :'cosponsor_company_name',
+        :'cosponsor_group_id' => :'cosponsor_group_id',
+        :'cosponsor_group_name' => :'cosponsor_group_name',
+        :'cosponsor_root_id' => :'cosponsor_root_id',
+        :'cosponsor_rank' => :'cosponsor_rank',
+        :'member_rank' => :'member_rank',
+        :'n_members' => :'n_members',
+        :'n_candidates' => :'n_candidates',
+        :'n_shared_trials' => :'n_shared_trials',
+        :'n_trials_company_lead' => :'n_trials_company_lead',
+        :'n_trials_cosponsor_lead' => :'n_trials_cosponsor_lead',
+        :'first_shared_start_year' => :'first_shared_start_year',
+        :'last_shared_start_year' => :'last_shared_start_year',
+        :'n_shared_conditions' => :'n_shared_conditions',
+        :'top_shared_conditions' => :'top_shared_conditions'
+      }
+    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
+      {
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'row_level' => :'String',
+        :'cosponsor_company_id' => :'String',
+        :'cosponsor_company_name' => :'String',
+        :'cosponsor_group_id' => :'String',
+        :'cosponsor_group_name' => :'String',
+        :'cosponsor_root_id' => :'String',
+        :'cosponsor_rank' => :'Integer',
+        :'member_rank' => :'Integer',
+        :'n_members' => :'Integer',
+        :'n_candidates' => :'Integer',
+        :'n_shared_trials' => :'Integer',
+        :'n_trials_company_lead' => :'Integer',
+        :'n_trials_cosponsor_lead' => :'Integer',
+        :'first_shared_start_year' => :'Integer',
+        :'last_shared_start_year' => :'Integer',
+        :'n_shared_conditions' => :'Integer',
+        :'top_shared_conditions' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'row_level',
+        :'cosponsor_company_id',
+        :'cosponsor_company_name',
+        :'cosponsor_group_id',
+        :'cosponsor_group_name',
+        :'cosponsor_root_id',
+        :'cosponsor_rank',
+        :'member_rank',
+        :'n_members',
+        :'n_candidates',
+        :'n_shared_trials',
+        :'n_trials_company_lead',
+        :'n_trials_cosponsor_lead',
+        :'first_shared_start_year',
+        :'last_shared_start_year',
+        :'n_shared_conditions',
+        :'top_shared_conditions'
+      ])
+    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::CompanyCosponsorsRow` 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::CompanyCosponsorsRow`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'row_level')
+        self.row_level = attributes[:'row_level']
+      end
+
+      if attributes.key?(:'cosponsor_company_id')
+        self.cosponsor_company_id = attributes[:'cosponsor_company_id']
+      end
+
+      if attributes.key?(:'cosponsor_company_name')
+        self.cosponsor_company_name = attributes[:'cosponsor_company_name']
+      end
+
+      if attributes.key?(:'cosponsor_group_id')
+        self.cosponsor_group_id = attributes[:'cosponsor_group_id']
+      end
+
+      if attributes.key?(:'cosponsor_group_name')
+        self.cosponsor_group_name = attributes[:'cosponsor_group_name']
+      end
+
+      if attributes.key?(:'cosponsor_root_id')
+        self.cosponsor_root_id = attributes[:'cosponsor_root_id']
+      end
+
+      if attributes.key?(:'cosponsor_rank')
+        self.cosponsor_rank = attributes[:'cosponsor_rank']
+      end
+
+      if attributes.key?(:'member_rank')
+        self.member_rank = attributes[:'member_rank']
+      end
+
+      if attributes.key?(:'n_members')
+        self.n_members = attributes[:'n_members']
+      end
+
+      if attributes.key?(:'n_candidates')
+        self.n_candidates = attributes[:'n_candidates']
+      end
+
+      if attributes.key?(:'n_shared_trials')
+        self.n_shared_trials = attributes[:'n_shared_trials']
+      end
+
+      if attributes.key?(:'n_trials_company_lead')
+        self.n_trials_company_lead = attributes[:'n_trials_company_lead']
+      end
+
+      if attributes.key?(:'n_trials_cosponsor_lead')
+        self.n_trials_cosponsor_lead = attributes[:'n_trials_cosponsor_lead']
+      end
+
+      if attributes.key?(:'first_shared_start_year')
+        self.first_shared_start_year = attributes[:'first_shared_start_year']
+      end
+
+      if attributes.key?(:'last_shared_start_year')
+        self.last_shared_start_year = attributes[:'last_shared_start_year']
+      end
+
+      if attributes.key?(:'n_shared_conditions')
+        self.n_shared_conditions = attributes[:'n_shared_conditions']
+      end
+
+      if attributes.key?(:'top_shared_conditions')
+        if (value = attributes[:'top_shared_conditions']).is_a?(Array)
+          self.top_shared_conditions = value
+        end
+      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 &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          row_level == o.row_level &&
+          cosponsor_company_id == o.cosponsor_company_id &&
+          cosponsor_company_name == o.cosponsor_company_name &&
+          cosponsor_group_id == o.cosponsor_group_id &&
+          cosponsor_group_name == o.cosponsor_group_name &&
+          cosponsor_root_id == o.cosponsor_root_id &&
+          cosponsor_rank == o.cosponsor_rank &&
+          member_rank == o.member_rank &&
+          n_members == o.n_members &&
+          n_candidates == o.n_candidates &&
+          n_shared_trials == o.n_shared_trials &&
+          n_trials_company_lead == o.n_trials_company_lead &&
+          n_trials_cosponsor_lead == o.n_trials_cosponsor_lead &&
+          first_shared_start_year == o.first_shared_start_year &&
+          last_shared_start_year == o.last_shared_start_year &&
+          n_shared_conditions == o.n_shared_conditions &&
+          top_shared_conditions == o.top_shared_conditions
+    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
+      [company_id, company_name, group_id, group_name, row_level, cosponsor_company_id, cosponsor_company_name, cosponsor_group_id, cosponsor_group_name, cosponsor_root_id, cosponsor_rank, member_rank, n_members, n_candidates, n_shared_trials, n_trials_company_lead, n_trials_cosponsor_lead, first_shared_start_year, last_shared_start_year, n_shared_conditions, top_shared_conditions].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