Skip to content

Commit

Permalink
Spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
ngreifer committed Jul 24, 2019
1 parent c1103b1 commit 5e754c0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion man/love.plot.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ love.plot(x,
\code{character}; which statistic(s) should be reported. For binary or multinomial treatments, the options are "mean.diffs" for mean differences (standardized or not according the selected \code{bal.tab} options), "variance.ratios" for variance ratios, and "ks.statistics" for Kolmogorov-Smirnov statistics. "mean.diffs" is the default. For continuous treatments, the only option is "correlations" for treatment-covariate correlations. Multiple options are allowed. Abbreviations allowed.
}
\item{threshold}{
\code{numeric}; an optional value to be used as a threshold marker in the plot. Can be either an unnamed vector with the same length as \code{stat}, where \code{NA} indicates no threshold, or a named vector containing the thresholds desired. For example, if \code{stat = c("mean.diffs", "ks.statistics")} one could set \code{threshold = c(.1, NA)} or \code{threshold = c(mean.diffs = .1)} to set a threshold only for mean differences. The names can be abbreviated (e.g., \code{threshold = c(m = .1)} for mean differences). If \code{x} is a \code{bal.tab} object and a theshold was set in it, its threshold will be used unless overridden using the \code{threshold} argument in \code{love.plot}.
\code{numeric}; an optional value to be used as a threshold marker in the plot. Can be either an unnamed vector with the same length as \code{stat}, where \code{NA} indicates no threshold, or a named vector containing the thresholds desired. For example, if \code{stat = c("mean.diffs", "ks.statistics")} one could set \code{threshold = c(.1, NA)} or \code{threshold = c(mean.diffs = .1)} to set a threshold only for mean differences. The names can be abbreviated (e.g., \code{threshold = c(m = .1)} for mean differences). If \code{x} is a \code{bal.tab} object and a threshold was set in it, its threshold will be used unless overridden using the \code{threshold} argument in \code{love.plot}.
}
\item{abs}{
\code{logical}; whether to present the statistic in absolute value or not. For variance ratios, this will force all ratios to be greater than or equal to 1. If \code{x} is a \code{bal.tab} object, \code{love.plot()} might ignore \code{abs} depending on the original \code{bal.tab()} call.
Expand Down

0 comments on commit 5e754c0

Please sign in to comment.