GeoExperimentData: Constructs a GeoExperimentData object.

Description Usage Arguments Details Value

View source: R/geoexperimentdata.R

Description

Constructs a GeoExperimentData object.

Usage

1
GeoExperimentData(geo.timeseries, periods, geo.assignment, treat.assignment)

Arguments

geo.timeseries

a GeoTimeseries object.

periods

an ExperimentPeriods object, specifying the start and end dates of each period in the experiment. Or, NULL if the dates are yet unknown. Or, leave unspecified to extract this information from the column 'periods' of the geo.timeseries; in this case the column must exist in the data frame.

geo.assignment

a GeoAssignment object, specifying the mapping from a geo to a geo group. Or, NULL if the geo assignment is yet unknown. Or, leave unspecified to extract this information from the column 'geo.group' of geo.timeseries; in this case the column must exist in the data frame.

treat.assignment

a TreatmentAssignment object, specifying the mapping from (period, geo) to a treatment assignment condition (treatment intervention type). Or, NULL if the treatment assignment is yet unknown. Or, leave unspecified to extract this information from the column assignment of geo.timeseries. If the column assignment does not exist, the resulting object will have the column assignment filled with NAs.

Details

If any of the arguments periods, geo.assignment, or treat.assignment is NULL, the corresponding column (period, geo.group, assignment) in the resulting GeoExperimentData object will have only NAs.

If geo.timeseries has columns period, geo.group, or assignment, they will be overwritten by the values specified by periods, geo.assignment, and treat.assignment.

The resulting object may have undefined periods, geo.group, or assignment. The missing parts may be filled in by using the functions SetExperimentPeriods, SetGeoAssignment, and SetTreatmentAssignment.

Value

A GeoExperimentData object.


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