зеркало из https://github.com/microsoft/wpa.git
60 строки
1.8 KiB
R
60 строки
1.8 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/IV_report.R
|
|
\name{IV_report}
|
|
\alias{IV_report}
|
|
\title{Generate a Information Value HTML Report}
|
|
\usage{
|
|
IV_report(
|
|
data,
|
|
predictors = NULL,
|
|
outcome,
|
|
bins = 5,
|
|
path = "IV report",
|
|
timestamp = TRUE
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{data}{A Standard Person Query dataset in the form of a data frame.}
|
|
|
|
\item{predictors}{A character vector specifying the columns to be used as predictors.
|
|
Defaults to NULL, where all numeric vectors in the data will be used as predictors.}
|
|
|
|
\item{outcome}{A string specifying a binary variable, i.e. can only contain
|
|
the values 1 or 0.}
|
|
|
|
\item{bins}{Number of bins to use in \code{Information::create_infotables()}, defaults to 10.}
|
|
|
|
\item{path}{Pass the file path and the desired file name, \emph{excluding the file extension}.
|
|
For example, "collaboration report".}
|
|
|
|
\item{timestamp}{Logical vector specifying whether to include a timestamp in the file name.
|
|
Defaults to TRUE.}
|
|
}
|
|
\description{
|
|
The function generates an interactive HTML report using
|
|
Standard Person Query data as an input. The report contains a full Information Value analysis, a data exploration technique that helps determine which columns in a data set have predictive power or influence on the value of a specified dependent variable.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
sq_data \%>\%
|
|
mutate(X = ifelse(Collaboration_hours > 12, 1, 0)) \%>\% # Simulate binary variable
|
|
IV_report(outcome = "CH_binary", predictors = c("Email_hours", "Workweek_span"))
|
|
}
|
|
|
|
}
|
|
\seealso{
|
|
Other Reports:
|
|
\code{\link{capacity_report}()},
|
|
\code{\link{coaching_report}()},
|
|
\code{\link{collaboration_report}()},
|
|
\code{\link{connectivity_report}()},
|
|
\code{\link{generate_report}()},
|
|
\code{\link{validation_report}()}
|
|
|
|
Other Information Value:
|
|
\code{\link{IV_by_period}()},
|
|
\code{\link{create_IV}()}
|
|
}
|
|
\concept{Information Value}
|
|
\concept{Reports}
|