clean_db: Clean up a directory from extracted workout sub-directories.

Description Usage Arguments Details Value

View source: R/GoldenCheetahOpenData-package.R

Description

Clean up a directory from extracted workout sub-directories.

Usage

1
2
3
4
5
6
7
clean_db(object, confirm = TRUE, verbose = TRUE)

## S3 method for class 'character'
clean_db(object, confirm = TRUE, verbose = TRUE)

## S3 method for class 'gcod_db'
clean_db(object, confirm = TRUE, verbose = TRUE)

Arguments

object

either a character string giving the path to the directory to look for workout sub-directories or an object of class gcod_db.

confirm

logical determining whether the user should be prompted to confirm whether they should continue with the deletion. Default is TRUE.

verbose

logical determining whether progress information should be printed. Default is TRUE.

Details

If object is an object of class gcod_db, then clean_db, looks for sub-directories with the same name as the zip files local_path(object).

Value

If object is a character string, then nothing is returned. If object is a gcod_db object, then the object is returned, with all elements of local_perspective(object)$extracted set to FALSE.


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