read_tome_data.frame: Read a data.frame from a tome file

Description Usage Arguments

View source: R/read_tome_lowlevel.R

Description

Read a data.frame from a tome file

Usage

1
2
read_tome_data.frame(tome, df_name, stored_as = "data.frame",
  columns = NULL, match_type = "exact", get_all = FALSE)

Arguments

tome

tome file to read

df_name

character, the name of the data.frame object in the tome file structure

stored_as

character, the storage mode of the data.frame used in write_tome_data.frame. Default = "data.frame". If "data.frame", will read the df_name as a compound object. If "vectors" will read separate column vectors and build a data.frame.

columns

character vector, specific columns to read (only if the object was stored as vectors).

match_type

Whether to match column names exactly ("exact") or using grep ("grep"). Default is "exact".

get_all

logical, whether or not to append all other columns after the specified columns (only if the object was stored as vectors).


AllenInstitute/scrattch.io documentation built on Nov. 17, 2021, 10:06 a.m.