Skip to contents

Download example tracking data

Source: R/get_example_data.R
get_example_data.Rd

Downloads example data for different animal tracking software and returns the path to the downloaded file. The function caches the data to avoid repeated downloads.

Usage

get_example_data(source, cache_dir = tempdir())

Arguments

source

Character string specifying the tracking software. Currently supported:

  • "deeplabcut": Data from DeepLabCut tracking

cache_dir

Character string specifying the directory where to cache the downloaded files. Defaults to a temporary directory using tempdir().

Value

Character string with the path to the downloaded file.

Details

The function downloads example data from a GitHub repository and caches it locally. If the file already exists in the cache directory, it will use the cached version instead of downloading it again.

The data sources are hosted at: https://github.com/roaldarbol/movement-data

Examples

if (FALSE) { # \dontrun{
# Get path to DeepLabCut example data
path <- get_example_data("deeplabcut")

# Read the data using preferred method
data <- read_deeplabcut(path)
} # }