Print, summarise and coerce a longitudinal design schedule
Source:R/design_schedule.R
print.svyplan_schedule.Rdprint() states the issue profile as a run of takes rather than as one
row per occasion, because a schedule's occasions are mostly identical and
its length is set by the reporting horizon rather than by the design.
summary() gives the occasion-by-occasion tables: the issue profile in
full, the component activity, the overlap the rotation produces, and the
interviews owed after the horizon. as.data.frame() returns the issue
profile, and every table stays reachable as a field.
Usage
# S3 method for class 'svyplan_schedule'
print(x, ...)
# S3 method for class 'svyplan_schedule'
summary(object, ...)
# S3 method for class 'summary.svyplan_schedule'
print(x, ...)
# S3 method for class 'svyplan_schedule'
format(x, ...)
# S3 method for class 'svyplan_schedule'
as.data.frame(
x,
row.names = NULL,
optional = FALSE,
stringsAsFactors = FALSE,
validRN = TRUE,
...
)
# S3 method for class 'svyplan_schedule'
x$name <- value
# S3 method for class 'svyplan_schedule'
x[i] <- value
# S3 method for class 'svyplan_schedule'
x[[i]] <- valueArguments
- x
An
svyplan_schedule, or thesummary.svyplan_scheduleobjectsummary()returns.- ...
Additional arguments are not supported and produce an error.
- object
An
svyplan_schedule.- row.names, optional, stringsAsFactors, validRN
Standard
as.data.frame()arguments.- name, i, value
Standard replacement arguments for
$<-,[[<-, and[<-. These operations are refused because they would break reconciliation within the schedule object.
Value
print() returns its argument invisibly, summary() an object of
class summary.svyplan_schedule carrying the schedule and its four
tables, format() one descriptive string, and as.data.frame() the
issue profile.
Direct field and table replacement with $<-, [[<-, or [<- is refused
because the metadata and tables describe one reconciled design. Recompute
with design_schedule() to change the plan, or extract a table first to
modify a plain data frame.