R/data.R

In FrankLef/eflMuncher: Data Pre-processing Tools Used by FL

#' Example Dataframe to Use with Fencing Algorithm
#'
#' Example dataframe to use with fencing algorithm.
#'
#' An example with data points outside of the \emph{fence} processed with the
#' fencing algorithm. See \code{prune_fence} function for details.
#'
#' @docType data
#'
#' @format Dataframe with 10 rows and 5 variables.
#' \describe{
#'   \item{X}{x values.}
#'   \item{Y}{y values.}
#'   \item{prune_id}{prune id for fence, NA_character or oob_fence.}
#'   \item{oob}{FALSE if at or inside the fence, TRUE otherwise
#'   (i.e. out-of-bound).}
#'   \item{label}{Label. Usually used for plotting.}
#' }
#'
"fences_df"

#' Example Dataframe, With \code{NA}s, to Use with Fencing Algorithm
#'
#' Example dataframe, with \code{NA}s, to use with fencing algorithm.
#'
#' An example with data points outside of the \emph{fence} and \code{NA} that
#' are processed with the fencing algorithm. See \code{prune_fence} function
#' for details.
#'
#' @docType data
#'
#' @format Dataframe with 10 rows and 5 variables.
#' \describe{
#'   \item{X}{x values.}
#'   \item{Y}{y values.}
#'   \item{prune_id}{prune id for fence, NA_character or oob_fence.}
#'   \item{oob}{FALSE if at or inside the fence, TRUE otherwise
#'   (i.e. out-of-bound).}
#'   \item{label}{Label. Usually used for plotting.}
#' }
#'
"fencesNA_df"

#' Example of Pruned Data with Iris
#'
#' Example of pruned data with iris.
#'
#' See the \code{prune_fence} for more details. See \code{iris} for more
#' details on the original data.
#'
#' @docType data
#'
#' @format Dataframe with 150 rows and 6 variables.
#' \describe{
#'   \item{Sepal.Length}{Sepal length.}
#'   \item{Sepal.Width}{Sepal width.}
#'   \item{Petal.Length}{Petal length.}
#'   \item{Petal.Width}{Petal width.}
#'   \item{Species}{Species are iris setosa, versicolor and virginica.}
#'   \item{prune_id}{prune id for fence, NA_character or oob_fence.}
#' }
#'
"iris_pruned"