summary() generates a summary of the weightit or weightitMSM object to evaluate the properties of the estimated weights.
# S3 method for weightit
summary(object, top = 5,
ignore.s.weights = FALSE, ...)# S3 method for summary.weightit
print(x, ...)
# S3 method for weightitMSM
summary(object, top = 5,
ignore.s.weights = FALSE, ...)
# S3 method for summary.weightitMSM
print(x, ...)
a weightit or weightitMSM object; the output of a call to weightit() or weightitMSM().
how many of the largest and smallest weights to display. Default is 5.
whether or not to ignore sampling weights when computing the weight summary. If FALSE, the default, the estimated weights will be multiplied by the sampling weights (if any) before values are computed.
a summary.weightit or summary.weightitMSM object; the output of a call to summary.weightit() or summary.weightitMSM().
arguments passed to print.
For point treatments (i.e., weightit objects), a summary.weightit object with the following elements:
The range (minimum and maximum) weight for each treatment group.
The units with the greatest weights in each treatment group; how many are included is determined by top.
The ratio of the largest weight to the smallest weight in each treatment group and overall.
The coefficient of variation (standard deviation divided by mean) of the weights in each treatment group and overall.
The effective sample size for each treatment group before and after weighting.
For longitudinal treatments (i.e., weightitMSM objects), a list of the above elements for each treatment period.
# NOT RUN {
# See example at ?weightit or ?weightitMSM
# }
Run the code above in your browser using DataLab