gcod_db_extractors: Extract information from an object of class 'gcod_db', as...

In ikosmidis/GoldenCheetahOpenData: R API and Local Database Management for the GoldenCheetah OpenData Project

Description

Extract information from an object of class gcod_db, as produced by get_athlete_ids().

Usage

read_workouts(object, ...)

n_ids(object, ...)

min_size(object, ...)

max_size(object, ...)

total_size(object, ...)

mean_size(object, ...)

local_path(object, ...)

remote_perspective(object, ...)

local_perspective(object, ...)

athlete_id(object, ...)

rebuild_db(object, ...)

## S3 method for class 'gcod_db'
n_ids(object, perspective = "remote", ...)

## S3 method for class 'gcod_db'
min_size(object, perspective = "remote", ...)

## S3 method for class 'gcod_db'
max_size(object, perspective = "remote", ...)

## S3 method for class 'gcod_db'
total_size(object, perspective = "remote", ...)

## S3 method for class 'gcod_db'
mean_size(object, perspective = "remote", ...)

## S3 method for class 'gcod_db'
local_path(object, ...)

## S3 method for class 'gcod_db'
remote_perspective(object, ...)

## S3 method for class 'gcod_db'
local_perspective(object, ...)

## S3 method for class 'gcod_db'
athlete_id(object, perspective = "remote", ...)

Arguments

object	an object of class gcod_db, as produced by get_athlete_ids().
...	currently not used.
perspective	either "remote" (default) or "local", for the perspective to use for the extractor function.

Details

File sizes from the min_size(), max_size(), total_size(), mean_size() extractors are reported in bytes but inherit from class object_size. So, format.object_size() can be used directly for pretty units, etc.

local_path() extracts the local paths from the gcod_db file.

remote_perspective(object) and local_perspective(object) are equivalent to object$remote_db and object$local_db, respectively.

n_ids() returns the number of athlete ids in the specified perspective, and athlete_id() the athlete IDs themselves.

See Also

get_athlete_ids()

ikosmidis/GoldenCheetahOpenData documentation built on June 3, 2020, 9:25 a.m.