update docstring location, include estimation call

JuliaStats · Aug 9, 2023 · 5f85bfc · 5f85bfc
1 parent 3ecf54b
commit 5f85bfc
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/docs/src/km.md b/docs/src/km.md
@@ -24,6 +24,7 @@ using Greenwood's formula:
 
 ```@docs
 Survival.KaplanMeier
+Survival.KaplanMeier(t::Real)
 StatsAPI.fit(::Type{KaplanMeier}, ::Any, ::Any)
 StatsAPI.confint(::KaplanMeier)
 ```

diff --git a/docs/src/na.md b/docs/src/na.md
@@ -24,6 +24,7 @@ from ``n_i`` samples:
 
 ```@docs
 Survival.NelsonAalen
+Survival.NelsonAalen(t::Real)
 StatsAPI.fit(::Type{NelsonAalen}, ::Any, ::Any)
 StatsAPI.confint(::NelsonAalen)
 ```

diff --git a/src/kaplanmeier.jl b/src/kaplanmeier.jl
@@ -16,7 +16,14 @@ Use `fit(KaplanMeier, ...)` to compute the estimates as `Float64`
 values and construct this type.
 Alternatively, `fit(KaplanMeier{S}, ...)` may be used to request a
 particular value type `S` for the estimates.
+"""
+struct KaplanMeier{S,T} <: NonparametricEstimator
+    events::EventTable{T}
+    survival::Vector{S}
+    stderr::Vector{S}
+end
 
+"""
 To computes the survival estimation at time `t` of a KaplanMeier fit you can use.
 
 ```julia
@@ -25,12 +32,6 @@ t = 5
 km(t) # evaluates the estimator at time 5
 ```
 """
-struct KaplanMeier{S,T} <: NonparametricEstimator
-    events::EventTable{T}
-    survival::Vector{S}
-    stderr::Vector{S}
-end
-
 function (km::KaplanMeier)(t::Real)
     time_points = km.events.time
     survival = km.survival

diff --git a/src/nelsonaalen.jl b/src/nelsonaalen.jl
@@ -16,7 +16,14 @@ Use `fit(NelsonAalen, ...)` to compute the estimates as `Float64` values
 and construct this type.
 Alternatively, `fit(NelsonAalen{S}, ...)` may be used to request a
 particular value type `S` for the estimates.
+"""
+struct NelsonAalen{S,T} <: NonparametricEstimator
+    events::EventTable{T}
+    chaz::Vector{S}
+    stderr::Vector{S}
+end
 
+"""
 To computes the cumulative hazard estimation at time `t` of a NelsonAalen fit you can use.
 
 ```julia
@@ -25,12 +32,6 @@ t = 5
 na(t) # evaluates the estimator at time 5
 ```
 """
-struct NelsonAalen{S,T} <: NonparametricEstimator
-    events::EventTable{T}
-    chaz::Vector{S}
-    stderr::Vector{S}
-end
-
 function (na::NelsonAalen)(t::Real)
     time_points = na.events.time
     cumulative_hazard = na.chaz