From b0baeac3f077fd9ca454d1f3681fbbe7308cc94e Mon Sep 17 00:00:00 2001 From: nickhaf <82273391+nickhaf@users.noreply.github.com> Date: Thu, 23 Jun 2022 15:11:25 +0200 Subject: [PATCH] fixed typos (#125) * Fixed Typo closes #114 * fixed typo closes #113 * fixed typo closes #112 --- docs/src/tutorials/concept.md | 2 +- docs/src/tutorials/construction/construction.md | 2 +- src/observed/covariance.jl | 2 +- src/observed/data.jl | 4 ++-- src/observed/get_colnames.jl | 2 +- src/observed/missing.jl | 4 ++-- test/unit_tests/data_input_formats.jl | 6 +++--- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/src/tutorials/concept.md b/docs/src/tutorials/concept.md index 6f8b0790d..119e45280 100644 --- a/docs/src/tutorials/concept.md +++ b/docs/src/tutorials/concept.md @@ -28,7 +28,7 @@ Here is an overview on the available building blocks: | | | [`SemRidge`](@ref) | | | | | [`SemConstant`](@ref) | | -The rest of this page is explains the building blocks for each part. First, we explain every part and give an overview on the different options that are available. After that, the [API - model parts](@ref) section serves as a reference for detailed explanations about the different options. +The rest of this page explains the building blocks for each part. First, we explain every part and give an overview on the different options that are available. After that, the [API - model parts](@ref) section serves as a reference for detailed explanations about the different options. (How to stick them together to a final model is explained in the section on [Model construction](@ref).) ## The observed part aka [`SemObserved`](@ref) diff --git a/docs/src/tutorials/construction/construction.md b/docs/src/tutorials/construction/construction.md index 240b11248..0614611ce 100644 --- a/docs/src/tutorials/construction/construction.md +++ b/docs/src/tutorials/construction/construction.md @@ -1,6 +1,6 @@ # Model Construction -There are two different ways of constructing a SEM in our package. You can use the [Outer Constructor](@ref) oder [Build by parts](@ref). +There are two different ways of constructing a SEM in our package. You can use the [Outer Constructor](@ref) or [Build by parts](@ref). The final models will be the same, the outer constructor just has some sensible defaults that make your life easier. All tutorials until now used the outer constructor `Sem(specification = ..., data = ..., ...)`, which is normally the more convenient way. However, our package is build for extensibility, so there may be cases where **user-defined** parts of a model do not work with the outer constructor. diff --git a/src/observed/covariance.jl b/src/observed/covariance.jl index 97bb80245..55016fd95 100644 --- a/src/observed/covariance.jl +++ b/src/observed/covariance.jl @@ -34,7 +34,7 @@ Subtype of `SemObserved` ## Remarks (1) the `specification` argument can also be `nothing`, but this turns of checking whether the observed data/covariance columns are in the correct order! As a result, you should only -use this if you are shure your covariance matrix is in the right format. +use this if you are sure your covariance matrix is in the right format. ## Additional keyword arguments: - `spec_colnames::Vector{Symbol} = nothing`: overwrites column names of the specification object diff --git a/src/observed/data.jl b/src/observed/data.jl index aff14827a..79468e473 100644 --- a/src/observed/data.jl +++ b/src/observed/data.jl @@ -32,7 +32,7 @@ Subtype of `SemObserved` ## Remarks (1) the `specification` argument can also be `nothing`, but this turns of checking whether the observed data/covariance columns are in the correct order! As a result, you should only -use this if you are shure your observed data is in the right format. +use this if you are sure your observed data is in the right format. ## Additional keyword arguments: - `spec_colnames::Vector{Symbol} = nothing`: overwrites column names of the specification object @@ -85,7 +85,7 @@ function SemObservedData(; if data isa DataFrame throw(ArgumentError( "You passed your data as a `DataFrame`, but also specified `obs_colnames`. "* - "Please make shure the column names of your data frame indicate the correct variables "* + "Please make sure the column names of your data frame indicate the correct variables "* "or pass your data in a different format.") ) end diff --git a/src/observed/get_colnames.jl b/src/observed/get_colnames.jl index d86fddb1d..19d6e5a16 100644 --- a/src/observed/get_colnames.jl +++ b/src/observed/get_colnames.jl @@ -12,7 +12,7 @@ end function get_colnames(specification::RAMMatrices) if isnothing(specification.colnames) - @warn "Your RAMMatrices do not contain column names. Please make shure the order of variables in your data is correct!" + @warn "Your RAMMatrices do not contain column names. Please make sure the order of variables in your data is correct!" return nothing else colnames = specification.colnames[specification.F_ind] diff --git a/src/observed/missing.jl b/src/observed/missing.jl index 6ae2893b5..adf9c2f1c 100644 --- a/src/observed/missing.jl +++ b/src/observed/missing.jl @@ -48,7 +48,7 @@ Subtype of `SemObserved` ## Remarks (1) the `specification` argument can also be `nothing`, but this turns of checking whether the observed data/covariance columns are in the correct order! As a result, you should only -use this if you are shure your observed data is in the right format. +use this if you are sure your observed data is in the right format. ## Additional keyword arguments: - `spec_colnames::Vector{Symbol} = nothing`: overwrites column names of the specification object @@ -110,7 +110,7 @@ function SemObservedMissing(; if data isa DataFrame throw(ArgumentError( "You passed your data as a `DataFrame`, but also specified `obs_colnames`. "* - "Please make shure the column names of your data frame indicate the correct variables "* + "Please make sure the column names of your data frame indicate the correct variables "* "or pass your data in a different format.") ) end diff --git a/test/unit_tests/data_input_formats.jl b/test/unit_tests/data_input_formats.jl index 4f5382abb..77aed035e 100644 --- a/test/unit_tests/data_input_formats.jl +++ b/test/unit_tests/data_input_formats.jl @@ -27,7 +27,7 @@ dat_mean = vcat(Statistics.mean(dat_matrix, dims = 1)...) # errors @test_throws ArgumentError( "You passed your data as a `DataFrame`, but also specified `obs_colnames`. "* - "Please make shure the column names of your data frame indicate the correct variables "* + "Please make sure the column names of your data frame indicate the correct variables "* "or pass your data in a different format.") begin SemObservedData(specification = spec, data = dat, obs_colnames = Symbol.(names(dat))) end @@ -114,7 +114,7 @@ end # errors @test_throws ArgumentError( "You passed your data as a `DataFrame`, but also specified `obs_colnames`. "* - "Please make shure the column names of your data frame indicate the correct variables "* + "Please make sure the column names of your data frame indicate the correct variables "* "or pass your data in a different format.") begin SemObservedData(specification = spec, data = dat, obs_colnames = Symbol.(names(dat)), meanstructure = true) end @@ -337,7 +337,7 @@ end # errors @test_throws ArgumentError( "You passed your data as a `DataFrame`, but also specified `obs_colnames`. "* - "Please make shure the column names of your data frame indicate the correct variables "* + "Please make sure the column names of your data frame indicate the correct variables "* "or pass your data in a different format.") begin SemObservedMissing(specification = spec, data = dat_missing, obs_colnames = Symbol.(names(dat))) end