R/apartments.R

In DALEX2: Descriptive mAchine Learning EXplanations

#' Apartments Data
#'
#' Datasets \code{apartments} and \code{apartments_test} are artificial,
#' generated form the same model.
#' Structure of the dataset is copied from real-world dataset from \code{PBImisc} package,
#' but they were generated in a way to mimic effect of Anscombe quartet for complex black box models.
#'
#' \itemize{
#' \item m2.price - price per square meter
#' \item surface - apartment area in square meters
#' \item n.rooms - number of rooms (correlated with surface)
#' \item district - district in which apartment is located, factor with 10 levels
#' \item floor - floor
#' \item construction.date - construction year
#' }
#'
#' @aliases apartments_test
#' @docType data
#' @keywords apartments
#' @name apartments
#' @usage data(apartments)
#' @format a data frame with 1000 rows and 6 columns
NULL