forked from ModelOriented/DALEX
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plot.predict_profile.Rd
39 lines (35 loc) · 1.53 KB
/
plot.predict_profile.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/plot_predict_profile.R
\name{plot.predict_profile}
\alias{plot.predict_profile}
\title{Plot Variable Profile Explanations}
\usage{
\method{plot}{predict_profile}(x, ...)
}
\arguments{
\item{x}{an object of the class \code{predict_profile}}
\item{...}{other parameters}
}
\value{
An object of the class \code{ggplot}.
}
\description{
Plot Variable Profile Explanations
}
\section{Plot options}{
\subsection{ceteris_paribus}{
\itemize{
\item{\code{color}}{ a character. Either name of a color or name of a variable that should be used for coloring}
\item{\code{size}}{ a numeric. Size of lines to be plotted}
\item{\code{alpha}}{ a numeric between \code{0} and \code{1}. Opacity of lines}
\item{\code{facet_ncol}}{ number of columns for the \code{\link[ggplot2]{facet_wrap}}}
\item{\code{variables}}{ if not \code{NULL} then only \code{variables} will be presented}
\item{\code{variable_type}}{ a character. If \code{numerical} then only numerical variables will be plotted.
If \code{categorical} then only categorical variables will be plotted.}
\item{\code{title}}{ a character. Plot title. By default \code{"Ceteris Paribus profile"}.}
\item{\code{subtitle}}{ a character. Plot subtitle. By default \code{NULL} - then subtitle is set to "created for the XXX, YYY model",
where XXX, YYY are labels of given explainers.}
\item{\code{categorical_type}}{ a character. How categorical variables shall be plotted? Either \code{"lines"} (default) or \code{"bars"}.}
}
}
}