RunMacro: Runs a GISDK macro

Description Usage Arguments Details Examples

View source: R/caliperR.R

Description

A GISDK macro is a function defined in a GISDK scrip (.rsc). When working in Caliper software, these are always called in GISDK using the RunMacro() function.

Usage

1
RunMacro(macro_name, ..., process_result = TRUE)

Arguments

macro_name

string Name of the GISDK macro to run

...

Used to pass arguments to the GISDK macro

process_result

boolean Whether to attempt to process the result into a native R format.

Details

To run GISDK functions (like OpenTable()) see RunFunction.

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# These won't work unless Caliper software is installed.
RunMacro("G30 Tutorial Folder")
RunMacro("add", 1, 2)
#> 3
RunMacro("parse opts array", list("one" = 1, "two" = 2))
#> "The first option name is one. The first option value is 1."

## End(Not run)

dkyleward/caliperR documentation built on Feb. 13, 2021, 10:35 p.m.