These functions augment metadata so it can be subsequently loaded (with load_ethoscope).
1 2 3 4
object such as a data.frame, or the name of a file (see detail)
the url of the result directory on the data server
the directory where all data are saved
the name of an index_file, in
whether to download all files.
whether to print progress (a logical)
These function will augment metadata from two different types of inputs (
A data.frame (recomended)
In this case, the function will try to match requested data with data available on
The provided data.table has typically one row per requested individual and the columns
(not necessarily in this order):
machine_name – the name of the machine in which the individual was (e.g.
date – the start date of the experiment formatted as
region_id – the ROI in which the animal was. When not provided, all regions are queried.
time – the start time of the experiment formatted as "HH:MM:SS".
When not provided, and multiple experiment for the same machine exist, only the last one is loaded.
??? – any number of arbitrary columns* to associate
genotypes/... to the previous columns.
The name of a CSV file that contains a table as described in
A vector of
.db files to be read.
a data.table::data.table with the same rows as x, and extra columns for further data loading
metadata tutorial – how to work with metadata
load_ethoscope – to load the actual data
list_result_files – to list available file
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# Metadata with no region_id -> all regions will be loaded with the same metadata dir <- paste0(scopr_example_dir(), "/ethoscope_results/") data(no_region_id_metadata) metadata <- link_ethoscope_metadata(no_region_id_metadata, dir) print(metadata) # Metadata with region_id -> only stated regions will be loaded with specific metadata data(region_id_metadata) metadata <- link_ethoscope_metadata(region_id_metadata, dir) print(metadata) ## Not run: # If your files are stored on a remote server, # this will download to a local directory only the needed files REMOTE <- "ftp://a/remote/server/" LOCAL_DIR <- "/where/I/store/the/data/" metadata <- link_ethoscope_metadata_remote(region_id_metadata, REMOTE, LOCAL_DIR) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.