Skip to contents

ingest.vicinity_processed() is an ingest method that ingests data saved in external files into R objects stored in working memory. This method is implemented for the ready4 submodule class for tibble object lookup table of meta-data for spatial data packs (imported and pre-processed data). The function returns Object (an output object of multiple potential types).

ingest.vicinity_raw() is an ingest method that ingests data saved in external files into R objects stored in working memory. This method is implemented for the ready4 submodule class for tibble object lookup table of metadata about raw (un-processed) spatial data to import. The function returns Ingest (an output object of multiple potential types).

ingest method applied to VicinityProfile

Usage

ingest.vicinity_processed(
  x,
  col_nm_1L_chr = "main_feature_chr",
  match_value_xx,
  processed_fls_dir_1L_chr = NA_character_
)

# S4 method for vicinity_processed
ingest(
  x,
  col_nm_1L_chr = "main_feature_chr",
  match_value_xx,
  processed_fls_dir_1L_chr = NA_character_
)

ingest.vicinity_raw(
  x,
  args_ls = NULL,
  fn = function(x, ...) {
     NULL
 },
  imports_chr = character(0),
  data_type_1L_chr = character(0),
  path_1L_chr = character(0),
  raw_fls_dir_1L_chr = character(0),
  processed_fls_dir_1L_chr = character(0),
  what_1L_chr = "list",
  write_1L_lgl = T
)

# S4 method for vicinity_raw
ingest(
  x,
  args_ls = NULL,
  fn = function(x, ...) {
     NULL
 },
  imports_chr = character(0),
  data_type_1L_chr = character(0),
  path_1L_chr = character(0),
  raw_fls_dir_1L_chr = character(0),
  processed_fls_dir_1L_chr = character(0),
  what_1L_chr = "list",
  write_1L_lgl = T
)

# S4 method for VicinityProfile
ingest(x, key_var_1L_chr = character(0), what_1L_chr = "starter")

Arguments

x

An object of class VicinityProfile

col_nm_1L_chr

Column name (a character vector of length one), Default: 'main_feature_chr'

match_value_xx

Match value (an output object of multiple potential types)

processed_fls_dir_1L_chr

Processed files directory (a character vector of length one), Default: character(0)

args_ls

Arguments (a list), Default: NULL

fn

Function (a function), Default: function(x, ...) NULL

imports_chr

Imports (a character vector), Default: character(0)

data_type_1L_chr

Data type (a character vector of length one), Default: character(0)

path_1L_chr

Path (a character vector of length one), Default: character(0)

raw_fls_dir_1L_chr

Raw files directory (a character vector of length one), Default: character(0)

what_1L_chr

What (a character vector of length one), Default: 'starter'

write_1L_lgl

Write (a logical vector of length one), Default: T

key_var_1L_chr

Key variable (a character vector of length one), Default: character(0)

Value

Object (an output object of multiple potential types)

Ingest (an output object of multiple potential types)

Object (an output object of multiple potential types)