Geos: Constructor for Geos objects.

Description Usage Arguments Value

View source: R/geos.R

Description

Constructor for Geos objects.

Usage

1
Geos(x, volume = NULL)

Arguments

x

a data frame with column 'geo' and optionally other columns. Each 'geo' must be unique.

volume

name of the column that represents the 'volume' of the geo. The proportion of volume is computed. If omitted, the assumed volumes will be 1 for each geo. The volumes have to be non-negative and sum up to a positive value.

Value

An object of class 'Geos', which is a data frame with the column 'geo', the column 'proportion' and 'volume', and other optional columns. The rows are sorted by the descending order of 'volume'.


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