Skip to content

Commit

Permalink
increase linking and update formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
hfrick committed Sep 4, 2024
1 parent 79e7324 commit bb62a10
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 17 deletions.
14 changes: 7 additions & 7 deletions R/initial_split.R
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
#' Simple Training/Test Set Splitting
#'
#' `initial_split` creates a single binary split of the data into a training
#' set and testing set. `initial_time_split` does the same, but takes the
#' `initial_split()` creates a single binary split of the data into a training
#' set and testing set. `initial_time_split()` does the same, but takes the
#' _first_ `prop` samples for training, instead of a random selection.
#' `group_initial_split` creates splits of the data based
#' `group_initial_split()` creates splits of the data based
#' on some grouping variable, so that all data in a "group" is assigned to
#' the same split.
#'
#' @details `training` and `testing` are used to extract the resulting data.
#' the same split.
#'
#' @details `training()` and `testing()` are used to extract the resulting data.
#'
#' @template strata_details
#' @inheritParams vfold_cv
#' @inheritParams make_strata
#' @param prop The proportion of data to be retained for modeling/analysis.
#' @export
#' @return An `rsplit` object that can be used with the `training` and `testing`
#' @return An `rsplit` object that can be used with the `training()` and `testing()`
#' functions to extract the data in each split.
#' @examplesIf rlang::is_installed("modeldata")
#' set.seed(1353)
Expand Down
4 changes: 2 additions & 2 deletions R/initial_validation_split.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
#' based on some grouping variable, so that all data in a "group" are assigned
#' to the same partition.
#'
#' @details `training()`, `validation()`, and `testing()` can be used to extract the
#' @details [training()], [validation()], and [testing()] can be used to extract the
#' resulting data sets.
#' Use [`validation_set()`] to create an `rset` object for use with functions from
#' Use [validation_set()] to create an `rset` object for use with functions from
#' the tune package such as `tune::tune_grid()`.
#'
#' @template strata_details
Expand Down
2 changes: 1 addition & 1 deletion R/validation_set.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Create a Validation Split for Tuning
#'
#' `validation_set` creates a the validation split for model tuning.
#' `validation_set()` creates a the validation split for model tuning.
#'
#' @param split An object of class `initial_validation_split`, such as resulting
#' from [initial_validation_split()] or [group_initial_validation_split()].
Expand Down
10 changes: 5 additions & 5 deletions man/initial_split.Rd

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

2 changes: 1 addition & 1 deletion man/initial_validation_split.Rd

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

2 changes: 1 addition & 1 deletion man/validation_set.Rd

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

0 comments on commit bb62a10

Please sign in to comment.