Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove @ref occurrences pointing to Base #41

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Remove @ref occurrences pointing to Base #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions src/Statistics.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ export cor, cov, std, stdm, var, varm, mean!, mean,
Compute the mean of all elements in a collection.

!!! note
If `itr` contains `NaN` or [`missing`](@ref) values, the result is also
If `itr` contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if array contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
mean of non-missing values.

# Examples
Expand Down Expand Up @@ -318,9 +318,9 @@ over dimensions. In that case, `mean` must be an array with the same shape as
`mean(itr, dims=dims)` (additional trailing singleton dimensions are allowed).

!!! note
If array contains `NaN` or [`missing`](@ref) values, the result is also
If array contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if array contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
variance of non-missing values.
"""
varm(A::AbstractArray, m::AbstractArray; corrected::Bool=true, dims=:) = _varm(A, m, corrected, dims)
Expand Down Expand Up @@ -358,9 +358,9 @@ an array with the same shape as `mean(itr, dims=dims)` (additional trailing
singleton dimensions are allowed).

!!! note
If array contains `NaN` or [`missing`](@ref) values, the result is also
If array contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if array contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
variance of non-missing values.
"""
var(A::AbstractArray; corrected::Bool=true, mean=nothing, dims=:) = _var(A, corrected, mean, dims)
Expand Down Expand Up @@ -433,9 +433,9 @@ an array with the same shape as `mean(itr, dims=dims)` (additional trailing
singleton dimensions are allowed).

!!! note
If array contains `NaN` or [`missing`](@ref) values, the result is also
If array contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if array contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
standard deviation of non-missing values.
"""
std(A::AbstractArray; corrected::Bool=true, mean=nothing, dims=:) = _std(A, corrected, mean, dims)
Expand Down Expand Up @@ -473,9 +473,9 @@ over dimensions. In that case, `mean` must be an array with the same shape as
`mean(itr, dims=dims)` (additional trailing singleton dimensions are allowed).

!!! note
If array contains `NaN` or [`missing`](@ref) values, the result is also
If array contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if array contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
standard deviation of non-missing values.
"""
stdm(iterable, m; corrected::Bool=true) =
Expand Down Expand Up @@ -811,9 +811,9 @@ For an even number of elements no exact median element exists, so the result is
equivalent to calculating mean of two median elements.

!!! note
If `itr` contains `NaN` or [`missing`](@ref) values, the result is also
If `itr` contains `NaN` or `missing` values, the result is also
`NaN` or `missing` (`missing` takes precedence if `itr` contains both).
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
Use the `skipmissing` function to omit `missing` entries and compute the
median of non-missing values.

# Examples
Expand Down Expand Up @@ -879,7 +879,7 @@ defined in this paper:
- Def. 9: `alpha=3/8`, `beta=3/8`

!!! note
An `ArgumentError` is thrown if `v` contains `NaN` or [`missing`](@ref) values.
An `ArgumentError` is thrown if `v` contains `NaN` or `missing` values.

# References
- Hyndman, R.J and Fan, Y. (1996) "Sample Quantiles in Statistical Packages",
Expand Down Expand Up @@ -1011,8 +1011,8 @@ defined in this paper:
- Def. 9: `alpha=3/8`, `beta=3/8`

!!! note
An `ArgumentError` is thrown if `v` contains `NaN` or [`missing`](@ref) values.
Use the [`skipmissing`](@ref) function to omit `missing` entries and compute the
An `ArgumentError` is thrown if `v` contains `NaN` or `missing` values.
Use the `skipmissing` function to omit `missing` entries and compute the
quantiles of non-missing values.

# References
Expand Down