Use keyword syntax for ess, ess_rhat, rhat, and mcse

Project.toml

@@ -5,6 +5,7 @@ version = "0.3.0-DEV"
 
 [deps]
 AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c"
+Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
 DataAPI = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
@@ -19,6 +20,7 @@ Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
 [compat]
 AbstractFFTs = "0.5, 1"
+Compat = "3.36.0, 4"
 DataAPI = "1.6"
 DataStructures = "0.18.3"
 Distributions = "0.25"

docs/src/index.md

@@ -6,16 +6,13 @@ CurrentModule = MCMCDiagnosticTools
 
 ## Effective sample size and $\widehat{R}$
 
-The effective sample size (ESS) and $\widehat{R}$ can be estimated with [`ess_rhat`](@ref).
-
 ```@docs
+ess
+rhat
 ess_rhat
-ess_rhat_bulk
-ess_tail
-rhat_tail
 ```
 
-The following methods are supported:
+The following `method`s are supported:
 
 ```@docs
 ESSMethod

src/MCMCDiagnosticTools.jl

@@ -1,6 +1,7 @@
 module MCMCDiagnosticTools
 
 using AbstractFFTs: AbstractFFTs
+using Compat: @constprop
 using DataAPI: DataAPI
 using DataStructures: DataStructures
 using Distributions: Distributions
@@ -16,18 +17,19 @@ using Statistics: Statistics
 
 export bfmi
 export discretediag
-export ess_rhat, ess_rhat_bulk, ess_tail, rhat_tail, ESSMethod, FFTESSMethod, BDAESSMethod
+export ess, ess_rhat, ESSMethod, FFTESSMethod, BDAESSMethod
 export gelmandiag, gelmandiag_multivariate
 export gewekediag
 export heideldiag
 export mcse
 export rafterydiag
+export rhat
 export rstar
 
 include("utils.jl")
 include("bfmi.jl")
 include("discretediag.jl")
-include("ess.jl")
+include("ess_rhat.jl")
 include("gelmandiag.jl")
 include("gewekediag.jl")
 include("heideldiag.jl")