Documentation tweaks

src/interface.jl

@@ -20,78 +20,91 @@ end
 
 """
 `teststat(::WildBootTests.BootTestResult{T}) -> T`
+
 Given a wildboottest() return object, extract test statistic
 """
 teststat(o::BootTestResult) = o.stat
 
 """
 `stattype(::WildBootTests.BootTestResult{T}) -> String`
+
 Given a wildboottest() return object, extract type of test statistic: "t", "z", "F", or "χ²"
 """
 stattype(o::BootTestResult) = o.stattype
 
 """
 `statnumer(::WildBootTests.BootTestResult{T}) -> T`
+
 Given a wildboottest() return object, extract numerator of test statistic
 """
 statnumer(o::BootTestResult) = o.b
 
 """
 `statvar(::WildBootTests.BootTestResult{T}) -> T`
+
 Given a wildboottest() return object, extract squared denominator of test statistic
 """
 statvar(o::BootTestResult) = o.V
 
 """
 `numerdist(::WildBootTests.BootTestResult{T}) -> Matrix{T}`
+
 Given a wildboottest() return object, extract bootstrap distribution of numerator of statistic
 """
 numerdist(o::BootTestResult) = o.numerdist
 
 """
 `dist(::WildBootTests.BootTestResult{T}) -> Matrix{T}`
+
 Given a wildboottest() return object, extract bootstrap distribution of statistic
 """
 dist(o::BootTestResult) = o.dist
 
 """
 `p(::WildBootTests.BootTestResult{T}) -> T`
+
 Given a wildboottest() return object, extract p value
 """
 p(o::BootTestResult) = o.p
 
 """
 `padj(::WildBootTests.BootTestResult{T}) -> T`
+
 Given a wildboottest() return object, extract p value after multiple-hypothesis adjustment, if any
 """
 padj(o::BootTestResult) = o.padj
 
 """
 `reps(::WildBootTests.BootTestResult{T}) -> Int64`
+
 Given a wildboottest() return object, extract number of replications
 """
 reps(o::BootTestResult) = o.reps
 
 """
 `repsfeas(::WildBootTests.BootTestResult{T}) -> Int64`
+
 Given a wildboottest() return object, extract actual number of replications, subject to enumeration of Rademacher draws
 """
 repsfeas(o::BootTestResult) = o.repsfeas
 
 """
 `nbootclust(::WildBootTests.BootTestResult{T}) -> Int64`
+
 Given a wildboottest() return object, extract number of bootstrapping clusters in test
 """
 nbootclust(o::BootTestResult) = o.nbootclust
 
 """
 `dof(::WildBootTests.BootTestResult{T}) -> Int64`
+
 Given a wildboottest() return object, extract degrees of freedom of test
 """
 dof(o::BootTestResult) = o.dof
 
 """
 `dof_r(::WildBootTests.BootTestResult{T}) -> Int64`
+
 Given a wildboottest() return object, extract residual degrees of freedom of test
 """
 dof_r(o::BootTestResult) = o.dof_r
@@ -109,20 +122,23 @@ plotpoints(o::BootTestResult) = o.plot
 
 """
 `peak(::WildBootTests.BootTestResult{T}) -> NamedTuple{(:X, :p), Tuple{Vector{T}, T}}`
+
 Given a wildboottest() return object for a one-dimensional test, return the parameter value with peak p value in test
 Return value is a 2-tuple with named entries `X` and `p` holding the parameter value and p value.
 """
 peak(o::BootTestResult) = o.peak
 
 """
 `ci(::WildBootTests.BootTestResult{T}) -> Matrix{T}`
+
 Given a wildboottest() return object for a one-dimensional test, extract the confidence interval(s)
 for test, one row per disjoint piece
 """
 ci(o::BootTestResult) = o.ci
 
 """
 `auxweights(::WildBootTests.BootTestResult{T}) -> Matrix{T}`
+
 Given a wildboottest() return object for a one-dimensional test, extract auxilliary weight matrix
 """
 auxweights(o::BootTestResult) = o.auxweights