GetObjectDefinition {hivModelling}R Documentation

GetObjectDefinition

Description

Returns object definition stored as text file.

Usage

GetObjectDefinition(
  objectName,
  path = system.file("ObjectDefinitions", package = "hivModelling"),
  section = NULL,
  includeFileName = FALSE
)

Arguments

objectName

Name of the object. Required.

path

Path to the object definition file. Optional. Default = system.file('ObjectDefinitions', package = 'hivModelling').

section

Name of section of the list to return. If not specified, then the whole specification is returned, otherwise only the specified section. Optional. Default = NULL.

includeFileName

Logical indicating to include file name in the returned list as field 'FileName'. Optional. Default = FALSE.

Value

List object.

Examples

## Not run: 
GetObjectDefinition(objectName = 'Model')
GetObjectDefinition(objectName = 'Model', section = 'Name')
GetObjectDefinition(objectName = 'Settings', section = 'Columns')

## End(Not run)


[Package hivModelling version 0.9.10 Index]