ExtractTreatmentAssignment: Extracts a TreatmentAssignment object.

In google/GeoexperimentsResearch: Geo Experiments

Description

Extracts a TreatmentAssignment object.

Usage

ExtractTreatmentAssignment(obj, ...)

## S3 method for class 'GeoTimeseries'
ExtractTreatmentAssignment(obj, strict = TRUE, ...)

Arguments

obj	An object.
...	further arguments passed to or from other methods.
strict	(flag) if FALSE, the function returns NULL if either of the columns 'geo.group' or 'period' does not exist. Otherwise, throws an error.

Value

A TreatmentAssignment object.

Note

ExtractTreatmentAssignment.GeoTimeseries: obj is supposed to have the columns 'period', 'geo.group', and 'assignment'.

A well-defined (period, group) pair (i.e., neither of them is missing) in the data frame implies that the corresponding (date, geo) pair is part of the experiment and must be therefore associated a treatment condition. Otherwise, if a date or a geo is not part of the experiment, the (date, geo) pair must have no treatment condition assignment. In other words, any (period, group) pair that maps to a non-missing treatment assignment must have no missing values. Conversely, any (period, group) pair with a missing value must map to a missing treatment assignment.

google/GeoexperimentsResearch documentation built on May 17, 2019, 7:42 a.m.