GisdkClass: R class that gives access to GISDK functions
In dkyleward/caliperR: Interacct with Caliper Software from R
Description
R class that gives access to GISDK functions
R class that gives access to GISDK functions
Details
This class makes it easy to call any arbitrary GISDK function from R.
Performs multiple dispatch based on the name of the method called. If the
named is one of a few caliperR functions, those are executed. If not, then
then the name is assumed to represent a GISDK function and is called over
COM.
Methods
Public methods
-
-
-
-
-
-
Method new()
On creation, attempts to connect to Caliper software if not
already connected.
Usage
GisdkClass$new()
Returns
A new GisdkClass object.
Method RunMacro()
Class implementation of caliperR::RunMacro().
Usage
GisdkClass$RunMacro(macro_name, ..., process_result = TRUE)
Arguments
macro_namestring The GISDK macro name to run.
...The arguments to pass to the GISDK macro.
process_resultboolean Whether to attempt to convert GISDK
data types to R. Defaults to true.
Method CreateObject()
Class implementation of caliperR::CreateObject().
Usage
GisdkClass$CreateObject(class_name, ...)
Arguments
class_namestring The name of the GISDK object to create.
...Any arguments to be passed to the object during creation.
Method SetAlternateInterface()
Class implementation of caliperR::SetAlternateInterface().
Usage
GisdkClass$SetAlternateInterface(ui_file = NULL)
Arguments
ui_filestring File path to the compiled UI file.
Method GetInterface()
Class implementation of caliperR::GetInterface().
Usage
GisdkClass$GetInterface()
Method clone()
The objects of this class are cloneable with this method.
Usage
GisdkClass$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
dkyleward/caliperR documentation built on Dec. 31, 2021, 7:11 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description
R class that gives access to GISDK functions
R class that gives access to GISDK functions
Details
This class makes it easy to call any arbitrary GISDK function from R.
Performs multiple dispatch based on the name of the method called. If the named is one of a few caliperR functions, those are executed. If not, then then the name is assumed to represent a GISDK function and is called over COM.
Methods
Public methods
Method new()
On creation, attempts to connect to Caliper software if not already connected.
Usage
GisdkClass$new()
Returns
A new GisdkClass object.
Method RunMacro()
Class implementation of caliperR::RunMacro().
Usage
GisdkClass$RunMacro(macro_name, ..., process_result = TRUE)
Arguments
macro_namestringThe GISDK macro name to run....The arguments to pass to the GISDK macro.
process_resultbooleanWhether to attempt to convert GISDK data types to R. Defaults to true.
Method CreateObject()
Class implementation of caliperR::CreateObject().
Usage
GisdkClass$CreateObject(class_name, ...)
Arguments
class_namestringThe name of the GISDK object to create....Any arguments to be passed to the object during creation.
Method SetAlternateInterface()
Class implementation of caliperR::SetAlternateInterface().
Usage
GisdkClass$SetAlternateInterface(ui_file = NULL)
Arguments
ui_filestringFile path to the compiled UI file.
Method GetInterface()
Class implementation of caliperR::GetInterface().
Usage
GisdkClass$GetInterface()
Method clone()
The objects of this class are cloneable with this method.
Usage
GisdkClass$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.