Skip to content

docs: fix minmax_run description and subtracted typo #114

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

Closed
LeonidasZhak wants to merge 1 commit into from
Closed

docs: fix minmax_run description and subtracted typo #114

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions R/RcppExports.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ length_run <- function(k = integer(1), lag = integer(1), idx = integer(0)) {
#' Running min/max
#'
#'
#' `min_run` calculates running minimum-maximum on given `x` numeric
#' vector, specified `k` window size.
#' `minmax_run` calculates running minimum or maximum on given `x` numeric vector.
#' @inheritParams runner
#' @inheritParams sum_run
#' @param metric `character` what to return, minimum or maximum
Expand Down
2 changes: 1 addition & 1 deletion R/utils.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
#' Formats time-unit-interval to valid for runner
#'
#' Formats time-unit-interval to valid for runner. User specifies `k` as
#' positive number but this means that this interval needs to be substracted
#' positive number but this means that this interval needs to be subtracted
#' from `idx` - because windows length extends window backwards in time.
#' The same situation for lag.
#' @param k (k or lag) object from runner to be formatted
Expand Down
2 changes: 1 addition & 1 deletion man/dot-reformat_k.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions man/minmax_run.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions src/minmax_run.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
//' Running min/max
//'
//'
//' `min_run` calculates running minimum-maximum on given `x` numeric
//' vector, specified `k` window size.
//' `minmax_run` calculates running minimum or maximum on given `x` numeric vector.
//' @inheritParams runner
//' @inheritParams sum_run
//' @param metric `character` what to return, minimum or maximum
Expand Down
Loading