Returns example data for package — get_example

This function loads and returns example data for the package. Which dataset is returned must be specified. Data will be downloaded from Figshare the first time it is used.

get_example_data(
  which_data,
  data_dir = system.file("extdata", package = "gimap"),
  refresh_data = FALSE
)

Arguments

which_data: options are "count" or "meta"; specifies which example dataset should be returned
data_dir: Where should the data be saved if applicable?
refresh_data: should the example data that's been downloaded be deleted and redownloaded?

Value

the respective example data either as a data frame or a specialized gimap_dataset depending on what was requested.

Examples

if (FALSE) { # \dontrun{

counts_timepoint <- get_example_data("count")
counts_treatment <- get_example_data("count_treatment")
gimap_timepoint_dataset <- get_example_data("gimap")
gimap_treatment_dataset <- get_example_data("gimap_treatment")
metadata <- get_example_data("meta")
annotation <- get_example_data("annotation")
} # }