add docstrings

TARGENE · Jan 31, 2024 · 1f6db9e · 1f6db9e
1 parent 31fa3ef
commit 1f6db9e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/counterfactual_mean_based/estimates.jl b/src/counterfactual_mean_based/estimates.jl
@@ -97,6 +97,11 @@ Performs a T test on the EICEstimate.
 HypothesisTests.OneSampleTTest(est::EICEstimate, Ψ₀=0) = 
     OneSampleTTest(est.estimate, est.std, est.n, Ψ₀)
 
+"""
+    significance_test(estimate::EICEstimate, Ψ₀=0)
+
+Performs a TTest
+"""
 significance_test(estimate::EICEstimate, Ψ₀=0) = OneSampleTTest(estimate, Ψ₀)
 
 Base.show(io::IO, mime::MIME"text/plain", est::Union{EICEstimate, ComposedEstimand}) =

diff --git a/src/estimates.jl b/src/estimates.jl
@@ -159,6 +159,11 @@ function HypothesisTests.OneSampleZTest(estimate::ComposedEstimate, Ψ₀=0)
     return OneSampleZTest(estimate.estimate[1], sqrt(estimate.cov[1]), estimate.n, Ψ₀)
 end
 
+"""
+    significance_test(estimate::ComposedEstimate, Ψ₀=zeros(size(estimate.estimate, 1)))
+
+Performs a TTest if the estimate is one dimensional and a HotellingT2Test otherwise.
+"""
 function significance_test(estimate::ComposedEstimate, Ψ₀=zeros(size(estimate.estimate, 1)))
     if length(estimate.estimate) == 1
         Ψ₀ = Ψ₀ isa AbstractArray ? first(Ψ₀) : Ψ₀