data_to_AST: AST File Writer

View source: R/data_to_AST.R

data_to_ASTR Documentation

AST File Writer

Description

Writes an 'IFC_data' object to a ast file

Usage

data_to_AST(
  obj,
  write_to,
  viewing_pop = "All",
  overwrite = FALSE,
  display_progress = TRUE,
  verbose = FALSE,
  ...
)

Arguments

obj

an 'IFC_data' object extracted with features extracted.

write_to

pattern used to export file. Placeholders, like "%d/%s_fromR.%e", will be substituted:
-%d: with full path directory of 'obj$fileName'
-%p: with first parent directory of 'obj$fileName'
-%e: with extension of 'obj$fileName' (without leading .)
-%s: with shortname from 'obj$fileName' (i.e. basename without extension).
Exported file extension will be deduced from this pattern. Note that it has to be a .ast.

viewing_pop

Character String. Allow user to change displayed population. Default is 'All'.

overwrite

whether to overwrite file or not. Default is FALSE. Note that if TRUE, it will overwrite exported file if path of 'obj$fileName' and deduced from 'write_to' arguments are different. Otherwise, you will get an error saying that overwriting source file is not allowed.
Note also that an original file, i.e. generated by IDEAS(R) or INSPIRE(R), will never be overwritten. Otherwise, you will get an error saying that overwriting original file is not allowed.

display_progress

whether to display a progress bar. Default is TRUE.

verbose

whether to display information (use for debugging purpose). Default is FALSE.

...

other arguments to be passed.

Value

It invisibly returns full path of exported file.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.