trackeR (version 1.0.0)

readContainer: Read a GPS container file.

Description

Read a GPS container file.

Usage

readContainer(file, type = c("tcx", "db3", "json"), table = "gps_data",
  timezone = "", sessionThreshold = 2, correctDistances = FALSE,
  country = NULL, mask = TRUE, fromDistances = NULL, speedunit = NULL,
  distanceunit = NULL, cycling = FALSE, lgap = 30, lskip = 5, m = 11,
  silent = FALSE, parallel = FALSE, cores = getOption("mc.cores", 2L))

Arguments

file

The path to the file.

type

The type of the GPS container file. Supported so far are tcx, db3, and json.

table

The name of the table in the database if type is set to db3, ignored otherwise.

timezone

The timezone of the observations as passed on to as.POSIXct. Ignored for JSON files.

sessionThreshold

The threshold in hours for the time difference between consecutive timestamps above which they are considered to belong to different training sessions.

correctDistances

Logical. Should the distances be corrected for elevation?

country

ISO3 country code for downloading altitude data. If NULL, country is derived from longitude and latitude.

mask

Logical. Passed on to getData. Should only the altitudes for the specified country be extracted (TRUE) or also those for the neighboring countries (FALSE)?

fromDistances

Logical. Should the speeds be calculated from the distance recordings instead of taken from the speed recordings directly. Defaults to TRUE for tcx and Golden Cheetah's json files and to FALSE for db3 files.

speedunit

Character string indicating the measurement unit of the speeds in the container file to be converted into meters per second. Default is m_per_s when type is tcx and km_per_h when type is db3 or json. See Details.

distanceunit

Character string indicating the measurement unit of the distance in the container file to be converted into meters. Default is m when type is tcx and km when type is db3 or json. See Details.

cycling

Logical. Do the data stem from cycling instead of running? If so, the unit of measurement for cadence is set to rev_per_min instead of steps_per_min.

lgap

Time in seconds corresponding to the minimal sampling rate.

lskip

Time in seconds between the last observation before a small break and the first imputed speed or the last imputed speed and the first observation after a small break.

m

Number of imputed observations in each small break.

silent

Logical. Should warnings be generated if any of the sanity checks on the data are triggered?

parallel

Logical. Should computation be carried out in parallel? (Not supported on Windows.)

cores

Number of cores for parallel computing.

Value

An object of class trackeRdata.

Details

Available options for speedunit currently are km_per_h, m_per_s, mi_per_h, ft_per_min and ft_per_s. Available options for distanceunit currently are km, m, mi and ft.

Reading Golden Cheetah's JSON files is experimental.

See Also

trackeRdata, readTCX, readDB3, readJSON

Examples

# NOT RUN {
filepath <- system.file("extdata", "2013-06-08-090442.TCX", package = "trackeR")
run <- readContainer(filepath, type = "tcx", timezone = "GMT")
# }