extract_workouts.gcod_db: Extract workouts from the workout archives downloaded using...

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

Description

Extract workouts from the workout archives downloaded using download_workouts().

Usage

extract_workouts(object, ...)

## S3 method for class 'gcod_db'
extract_workouts(
  object,
  verbose = FALSE,
  clean_db = TRUE,
  overwrite = TRUE,
  ...
)

Arguments

object	an object of class gcod_db as produced from download_workouts().
...	currently not used.
verbose	logical determining whether progress information should be printed. Default is FALSE.
clean_db	logical determining whether the workout directories should be deleted before extraction, if they already exist. Default is TRUE.
overwrite	logical determining whether the workout directories should be overwritten, if they already exist. Default is TRUE.

Details

Athlete IDs are inferred from local_path(object).

' The workouts are extracted and put in sub-directories in the same directory as the workout archives (i.e. where the files local_path(object) are). These sub-directories have exactly the same name as the archives (excluding the file extension).

Value

An object of class gcod_db which is the same as object except that the elements of local_perspective(object)$extracted are set to TRUE or FALSE depending on whether the corresponding workout archives were extracted successfully or not.

See Also

download_workouts()

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