From 32a0dd48e076c83c473f63fea7e157e9e2bc806b Mon Sep 17 00:00:00 2001 From: Milan Bouchet-Valat Date: Wed, 27 May 2020 14:23:49 +0200 Subject: [PATCH] Remove `@ref` occurrences pointing to Base This fixes warnings when building manual. --- src/Statistics.jl | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/Statistics.jl b/src/Statistics.jl index 53e7c58f..9a3b9ab8 100644 --- a/src/Statistics.jl +++ b/src/Statistics.jl @@ -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 @@ -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) @@ -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) @@ -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) @@ -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) = @@ -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 @@ -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", @@ -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