Skip to content

Commit eba2c8f

Browse files
committed
docs: update new-measure description
1 parent 5873c17 commit eba2c8f

2 files changed

Lines changed: 4 additions & 9 deletions

File tree

R/aaa-new.R

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,14 @@
1-
# File is named with `aaa-` so that it is loaded before any other files. We need
2-
# to call `new_*_metric()` internally from outside any function in the package,
3-
# so this file has to be sourced first. It is a bit of a hack, but works.
41
# Modified after https://github.com/tidymodels/yardstick/blob/main/R/aaa-new.R
52

6-
# ------------------------------------------------------------------------------
7-
83
#' Construct a new measure function
94
#' @keywords summary_stats
105
#'
116
#' @description
127
#' These functions provide convenient wrappers to create the three types of
138
#' measure functions in `tidyhydro`: measures of central tendency, variability
149
#' and symmetry. They add a measure-specific class to `fn` and
15-
#' mimic a behaviour of [yardstick::metric_set()]. These features are used
16-
#' by [measure_set()].
10+
#' mimic a behaviour of [metric_set][yardstick::metric_set]. These features
11+
#' are used by [measure_set].
1712
#'
1813
#' See [Custom performance
1914
#' metrics](https://www.tidymodels.org/learn/develop/metrics/) for more

man/new-measure.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)