stat_power 0.1.0.alpha.1

data/sig/stat_power.rbs

@@ -0,0 +1,264 @@
+module StatPower
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class DomainError < Error
+  end
+
+  class ConvergenceError < Error
+  end
+
+  class Result
+    attr_reader sample_size: Integer?
+    attr_reader power: Float?
+    attr_reader effect_size: Float?
+    attr_reader alpha: Float?
+
+    def initialize: (
+      sample_size: Integer?,
+      power: Float?,
+      effect_size: Float?,
+      alpha: Float?
+    ) -> void
+  end
+
+  class PowerResult
+    attr_reader sample_size: Float
+    attr_reader power: Float
+    attr_reader effect_size: Float
+    attr_reader alpha: Float
+    attr_reader alternative: Symbol
+    attr_reader analysis_method: String
+
+    def initialize: (
+      sample_size: Float,
+      power: Float,
+      effect_size: Float,
+      alpha: Float,
+      alternative: Symbol,
+      analysis_method: String
+    ) -> void
+
+    def required_sample_size: () -> Integer
+  end
+
+  class UnequalPowerResult
+    attr_reader sample_size1: Float
+    attr_reader sample_size2: Float
+    attr_reader power: Float
+    attr_reader effect_size: Float
+    attr_reader alpha: Float
+    attr_reader alternative: Symbol
+    attr_reader analysis_method: String
+
+    def initialize: (
+      sample_size1: Float,
+      sample_size2: Float,
+      power: Float,
+      effect_size: Float,
+      alpha: Float,
+      alternative: Symbol,
+      analysis_method: String
+    ) -> void
+
+    def required_sample_size1: () -> Integer
+    def required_sample_size2: () -> Integer
+    def total_sample_size: () -> Float
+    def required_total_sample_size: () -> Integer
+  end
+
+  module EffectSize
+    module Conventional
+      def self.resolve: (test: Symbol | String, size: Symbol | String) -> Float
+    end
+
+    module Proportion
+      def self.cohen_h: (p1: Numeric, p2: Numeric) -> Float
+    end
+  end
+
+  module NormalMean
+    def self.solve: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+  end
+
+  module Proportion
+    def self.one_sample: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+
+    def self.two_sample: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+
+    def self.two_sample_unequal: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size1: Numeric | nil,
+      ?sample_size2: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> UnequalPowerResult
+  end
+
+  module TTest
+    def self.one_sample: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+
+    def self.paired: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+
+    def self.two_sample: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+
+    def self.two_sample_unequal: (
+      ?effect_size: Numeric | Symbol | String | nil,
+      ?sample_size1: Numeric | nil,
+      ?sample_size2: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> UnequalPowerResult
+  end
+
+  module Correlation
+    def self.solve: (
+      ?correlation: Numeric | Symbol | String | nil,
+      ?sample_size: Numeric | nil,
+      ?alpha: Numeric | nil,
+      ?power: Numeric | nil,
+      ?alternative: Symbol | String
+    ) -> PowerResult
+  end
+
+  module SpecialFunctions
+    module Beta
+      def self.regularized: (Numeric x, a: Numeric, b: Numeric) -> Float
+    end
+  end
+
+  module Integration
+    module AdaptiveSimpson
+      def self.integrate: (
+        lower: Numeric,
+        upper: Numeric,
+        ?tolerance: Numeric,
+        ?max_depth: Integer
+      ) { (Float) -> Numeric } -> Float
+    end
+  end
+
+  module Distributions
+    module Normal
+      def self.pdf: (Numeric x) -> Float
+      def self.cdf: (Numeric x) -> Float
+      def self.survival: (Numeric x) -> Float
+      def self.quantile: (Numeric probability) -> Float
+    end
+
+    module StudentT
+      def self.pdf: (Numeric x, degrees_of_freedom: Numeric) -> Float
+      def self.cdf: (Numeric x, degrees_of_freedom: Numeric) -> Float
+      def self.survival: (Numeric x, degrees_of_freedom: Numeric) -> Float
+      def self.quantile: (Numeric probability, degrees_of_freedom: Numeric) -> Float
+    end
+
+    module NoncentralT
+      def self.cdf: (
+        Numeric x,
+        degrees_of_freedom: Numeric,
+        noncentrality: Numeric
+      ) -> Float
+
+      def self.survival: (
+        Numeric x,
+        degrees_of_freedom: Numeric,
+        noncentrality: Numeric
+      ) -> Float
+    end
+
+    module FDistribution
+      def self.pdf: (
+        Numeric x,
+        numerator_df: Numeric,
+        denominator_df: Numeric
+      ) -> Float
+
+      def self.cdf: (
+        Numeric x,
+        numerator_df: Numeric,
+        denominator_df: Numeric
+      ) -> Float
+
+      def self.survival: (
+        Numeric x,
+        numerator_df: Numeric,
+        denominator_df: Numeric
+      ) -> Float
+
+      def self.quantile: (
+        Numeric probability,
+        numerator_df: Numeric,
+        denominator_df: Numeric
+      ) -> Float
+    end
+
+    module NoncentralF
+      def self.cdf: (
+        Numeric x,
+        numerator_df: Numeric,
+        denominator_df: Numeric,
+        noncentrality: Numeric
+      ) -> Float
+
+      def self.survival: (
+        Numeric x,
+        numerator_df: Numeric,
+        denominator_df: Numeric,
+        noncentrality: Numeric
+      ) -> Float
+    end
+  end
+
+  module Solvers
+    module Bisection
+      def self.solve: (
+        lower: Numeric,
+        upper: Numeric,
+        ?absolute_tolerance: Float,
+        ?relative_tolerance: Float,
+        ?max_iterations: Integer
+      ) { (Float) -> Numeric } -> Float
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: stat_power
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha.1
+platform: ruby
+authors:
+- Diogo Ribeiro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-19 00:00:00.000000000 Z
+dependencies: []
+description: Native Ruby tools for statistical power analysis, sample-size determination,
+  effect-size calculations, and inverse power problems.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- RELEASING.md
+- ROADMAP.md
+- docs/mathematical_conventions.md
+- docs/pwr_parity.md
+- lib/stat_power.rb
+- lib/stat_power/correlation.rb
+- lib/stat_power/distributions/f_distribution.rb
+- lib/stat_power/distributions/noncentral_f.rb
+- lib/stat_power/distributions/noncentral_t.rb
+- lib/stat_power/distributions/normal.rb
+- lib/stat_power/distributions/student_t.rb
+- lib/stat_power/effect_size/conventional.rb
+- lib/stat_power/effect_size/proportion.rb
+- lib/stat_power/errors.rb
+- lib/stat_power/integration/adaptive_simpson.rb
+- lib/stat_power/normal_mean.rb
+- lib/stat_power/power_result.rb
+- lib/stat_power/proportion.rb
+- lib/stat_power/result.rb
+- lib/stat_power/solvers/bisection.rb
+- lib/stat_power/special_functions/beta.rb
+- lib/stat_power/t_test.rb
+- lib/stat_power/t_test_unequal.rb
+- lib/stat_power/unequal_power_result.rb
+- lib/stat_power/version.rb
+- sig/stat_power.rbs
+homepage: https://github.com/DiogoRibeiro7/stat_power
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/DiogoRibeiro7/stat_power
+  changelog_uri: https://github.com/DiogoRibeiro7/stat_power/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/DiogoRibeiro7/stat_power#readme
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Statistical power analysis and sample-size determination for Ruby
+test_files: []