diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..7ebc1ff --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,23 @@ +# adapted from https://github.com/JuliaDocs/Documenter.jl/blob/master/.github/workflows/SpellCheck.yml +# see docs at https://github.com/crate-ci/typos +name: Spell Check +on: [pull_request] + +jobs: + typos-check: + name: Spell Check with Typos + runs-on: ubuntu-latest + steps: + - name: Checkout Actions Repository + uses: actions/checkout@v4 + - name: Check spelling + uses: crate-ci/typos@master + # don't fail on typos in files not impacted by this PR + continue-on-error: true + with: + config: _typos.toml + write_changes: true + - uses: reviewdog/action-suggester@v1 + with: + tool_name: Typos + fail_on_error: true diff --git a/_typos.toml b/_typos.toml new file mode 100644 index 0000000..f8d9752 --- /dev/null +++ b/_typos.toml @@ -0,0 +1,20 @@ +# https://github.com/crate-ci/typos#false-positives +[default] + +[default.extend-identifiers] +Lik = "Lik" +missings = "missings" + +[default.extend-words] +Lik = "Lik" +missings = "missings" + +[type.package_toml] +# Don't check spellings in these files +extend-glob = ["Manifest.toml", "Project.toml"] +check-file = false + +[type.bib] +# contain lots of names, which are a great spot for false positives +extend-glob = ["*.bib"] +check-file = false diff --git a/docs/src/api.md b/docs/src/api.md index e686d16..9fed7ef 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -181,7 +181,7 @@ These are especially useful for diagnostics and model checking. The methods for `qqnorm` and `qqplot` are implemented using [Makie recipes](https://makie.juliaplots.org/v0.15.0/recipes.html). In other words, these are convenience wrappers for calling the relevant plotting methods on `residuals(model)`. -Specify the type of line on the QQ plots with the `qqline` keyword-argument. The default for `qqnorm` is `:fitrobust`, which delivers an R-style line connecting the first and third quartiles. The default for `qqplot` is `:identity`, which plots the line with slope = 1 and intercept = 0. The final possiblity is `:fit`, which plots the line of best fit (i.e. regressing the quantiles of the residuals onto the quantiles of the reference distribution). +Specify the type of line on the QQ plots with the `qqline` keyword-argument. The default for `qqnorm` is `:fitrobust`, which delivers an R-style line connecting the first and third quartiles. The default for `qqplot` is `:identity`, which plots the line with slope = 1 and intercept = 0. The final possibility is `:fit`, which plots the line of best fit (i.e. regressing the quantiles of the residuals onto the quantiles of the reference distribution). The reference distribution for `qqnorm` is the standard normal, which differs from [the behavior in previous versions of Makie](https://github.com/JuliaPlots/Makie.jl/pull/1277). diff --git a/src/ridge.jl b/src/ridge.jl index 5e39950..9c0bce7 100644 --- a/src/ridge.jl +++ b/src/ridge.jl @@ -15,7 +15,7 @@ Create a ridge plot for the bootstrap samples of the fixed effects. Densities are normalized so that the maximum density is always 1. -The highest density interval correspoding to `conf_level` is marked with a bar at the bottom of each density. +The highest density interval corresponding to `conf_level` is marked with a bar at the bottom of each density. Setting `conf_level=missing` removes the markings for the highest density interval. !!! note diff --git a/src/ridge2d.jl b/src/ridge2d.jl index 6a611e7..6703728 100644 --- a/src/ridge2d.jl +++ b/src/ridge2d.jl @@ -27,7 +27,7 @@ function ridge2d!(f::Union{Makie.FigureLike,Makie.GridLayout}, bs::MixedModelBoo isempty(cnames) && throw(ArgumentError("No parameters $ptype found.")) length(cnames) == 1 && - throw(ArgumentError("Only 1 $ptype-paramater found: 2D plots require at least 2.")) + throw(ArgumentError("Only 1 $ptype-parameter found: 2D plots require at least 2.")) splomaxes!(f, cnames, _ridge2d_panel!, Symbol.(cnames), tbl) return f end diff --git a/test/runtests.jl b/test/runtests.jl index 5157ccb..732a8f8 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -144,7 +144,7 @@ end @testset "ridge2d" begin @test_throws(ArgumentError("No parameters x found."), ridge2d(b1; ptype=:x)) - @test_throws(ArgumentError("Only 1 ρ-paramater found: 2D plots require at least 2."), + @test_throws(ArgumentError("Only 1 ρ-parameter found: 2D plots require at least 2."), ridge2d(b1; ptype=:ρ)) save(joinpath(OUTDIR, "ridge2d_beta.png"), ridge2d(b1)) save(joinpath(OUTDIR, "ridge2d_sigma.png"), ridge2d(b1; ptype=:σ))