R/data.R

#' Potability of Water Training Set
#'
#' A dataset containg the potability of water among other 9 other
#'  parameters of more than 1500 observations.
#'
#' \describe{
#'   \item{ph}{pH of water (0 to 14)}
#'   \item{Hardness}{Capacity of water to precipitate soap in mg/L}
#'   \item{Solids}{Total dissolved solids in ppm}
#'   \item{Chloramines}{Amount of Chloramines in ppm}
#'   \item{Sulfate}{Amount of Sulfates dissolved in mg/L}
#'   \item{Conductivity}{Electrical conductivity of water
#'     in microsiemens per centimeter}
#'   \item{Organic_carbon}{Amount of organic carbon in ppm}
#'   \item{Trihalomethanes}{Amount of Trihalomethanes in micrograms per liter}
#'   \item{Turbidity}{Measure of light emitting property of water
#'     in NTU}
#'   \item{Potability}{Indicates if water is safe for human
#'     consumption. Potable -1 and Not potable -0}
#' }
#' @docType data
#' @keywords datasets
#' @name water_potability
#' @usage data(water_potability)
#' @format A data frame with 1608 rows and 10 variables
#' @source \url{https://www.kaggle.com/adityakadiwal/water-potability}
NULL

#' Potability of Water Test Set
#'
#' A dataset containg the potability of water among other 9 other
#'  parameters of more than 400 observations.
#'
#' \describe{
#'   \item{ph}{pH of water (0 to 14)}
#'   \item{Hardness}{Capacity of water to precipitate soap in mg/L}
#'   \item{Solids}{Total dissolved solids in ppm}
#'   \item{Chloramines}{Amount of Chloramines in ppm}
#'   \item{Sulfate}{Amount of Sulfates dissolved in mg/L}
#'   \item{Conductivity}{Electrical conductivity of water
#'     in microsiemens per centimeter}
#'   \item{Organic_carbon}{Amount of organic carbon in ppm}
#'   \item{Trihalomethanes}{Amount of Trihalomethanes in micrograms per liter}
#'   \item{Turbidity}{Measure of light emitting property of water
#'     in NTU}
#'   \item{Potability}{Indicates if water is safe for human
#'     consumption. Potable -1 and Not potable -0}
#' }
#' @docType data
#' @keywords datasets
#' @name water_test
#' @usage data(water_test)
#' @format A data frame with 403 rows and 10 variables
#' @source \url{https://www.kaggle.com/adityakadiwal/water-potability}
NULL
samhaycock/sumcat documentation built on Dec. 22, 2021, 10:11 p.m.