Write a movement or event dataset to any supported format
Source:R/write_dataset.R
write_dataset.RdOne entry point for every format aniread writes, the counterpart of
read_dataset(). By default the format is worked out from the file
suffix.
Arguments
- data
An aniframe: an anipoint, anievent, or another frame built on them.
- path
Path to write to.
- format
Which format to write.
NULL(the default) infers it from the suffix ofpath. Otherwise one of the"write"sources inget_supported_sources().- by
Key columns to write one file per combination of, or
NULL(the default) for a single file. Any ofanicore::get_keys(); the role names"what"and"when"stand for all identity or all temporal keys, soby = c("what", "when")writes one file per track. See "Files per group".- ...
Passed on to the writer for
format.
Details
write_dataset() is a dispatcher, not a new writer: it works out which
writer to call and calls it.
When several formats write the same suffix, the first listed in
get_supported_sources() is inferred: a .csv is written as a plain table
by write_aniframe(), and inTRACKtive's CSV needs
format = "intracktive".
Parquet keeps everything: read_dataset() gives back the same class,
grouping and metadata that were written. Other formats keep what the
format can hold.
Files per group
With by, each file is named from path with the key values appended
before the suffix: "mice.csv" with by = "individual" gives
mice_individual-mouse1.csv, mice_individual-mouse2.csv, and so on, and
several keys give mice_individual-mouse1_session-2.csv.
For other names, put the keys in path in braces:
"{session}/mice_{individual}.csv". The braces then set by, so it can be
left out, and directories in path are created. Characters other than
letters, digits, ., _ and - in a value become -.
Each file holds an aniframe with the same class and metadata as data.
See also
read_dataset() to read the file back, get_supported_sources()
for what can be written, and the individual write_*() functions for
format-specific arguments.
Examples
data <- anicore::example_anipoint()
path <- tempfile(fileext = ".parquet")
write_dataset(data, path)
read_dataset(path)
#> # Individuals: 1, 2, 3
#> # Keypoints: head, neck, shoulder_right, shoulder_left, abdomen, hip_right,
#> # hip_left, knee_right, knee_left, foot_right, foot_left
#> # Sessions: 1
#> # Trials: 1
#> individual keypoint session trial time x y confidence
#> <int> <fct> <int> <int> <int> <dbl> <dbl> <dbl>
#> 1 1 head 1 1 1 -2.73 -0.417 0.426
#> 2 1 head 1 1 2 -0.117 1.04 0.826
#> 3 1 head 1 1 3 0.796 1.08 0.867
#> 4 1 head 1 1 4 -0.795 0.270 0.888
#> 5 1 head 1 1 5 0.125 0.905 0.699
#> 6 1 head 1 1 6 -0.346 -1.30 0.732
#> 7 1 head 1 1 7 0.490 -0.152 0.682
#> 8 1 head 1 1 8 0.0369 2.22 0.756
#> 9 1 head 1 1 9 0.944 -2.26 0.819
#> 10 1 head 1 1 10 -0.537 0.754 0.694
#> # ℹ 1,640 more rows
# Name the format where the suffix is shared
write_dataset(data, tempfile(fileext = ".csv"), format = "intracktive")
#> ✔ Wrote inTRACKtive CSV to /tmp/Rtmpis6inz/file194247ee7ea4.csv
# One file per individual, or per track
dir <- tempfile()
dir.create(dir)
write_dataset(data, file.path(dir, "mice.parquet"), by = "individual")
#> Wrote 3 files, one per individual, to /tmp/Rtmpis6inz/file19423034b875.
write_dataset(data, file.path(dir, "{individual}/{keypoint}.parquet"))
#> Wrote 33 files, one per individual and keypoint, to
#> /tmp/Rtmpis6inz/file19423034b875.
list.files(dir, recursive = TRUE)
#> [1] "1/abdomen.parquet" "1/foot_left.parquet"
#> [3] "1/foot_right.parquet" "1/head.parquet"
#> [5] "1/hip_left.parquet" "1/hip_right.parquet"
#> [7] "1/knee_left.parquet" "1/knee_right.parquet"
#> [9] "1/neck.parquet" "1/shoulder_left.parquet"
#> [11] "1/shoulder_right.parquet" "2/abdomen.parquet"
#> [13] "2/foot_left.parquet" "2/foot_right.parquet"
#> [15] "2/head.parquet" "2/hip_left.parquet"
#> [17] "2/hip_right.parquet" "2/knee_left.parquet"
#> [19] "2/knee_right.parquet" "2/neck.parquet"
#> [21] "2/shoulder_left.parquet" "2/shoulder_right.parquet"
#> [23] "3/abdomen.parquet" "3/foot_left.parquet"
#> [25] "3/foot_right.parquet" "3/head.parquet"
#> [27] "3/hip_left.parquet" "3/hip_right.parquet"
#> [29] "3/knee_left.parquet" "3/knee_right.parquet"
#> [31] "3/neck.parquet" "3/shoulder_left.parquet"
#> [33] "3/shoulder_right.parquet" "mice_individual-1.parquet"
#> [35] "mice_individual-2.parquet" "mice_individual-3.parquet"