processYaml-ANY-YamlContext.ObjectReference.S3-method: Process YAML Markup (ANY-YamlContext.ObjectReference.S3)

In rappster/yamlr: Processes YAML markup

Description

See generic: processYaml

Usage

## S4 method for signature 'ANY,YamlContext.ObjectReference.S3'
processYaml(from, ctx = NULL,
  where = parent.frame(), strict = FALSE, ...)

Arguments

from	ANY.
ctx	Signature argument. Markup proecessing context.
where	environment. Environment in which to assign the function in the src field of class ObjectReferenceYaml.S3. Only relevant in case the YAML has been provided via comments instead of an inline string as this involves some additional transformation steps.
strict	logical. TRUE: error if no YAML markup could be identified (which in turn results in field original in class ObjectReferencedYaml.S3 being empty); FALSE: no error if no YAML markup could be identified.
...	Further arguments to be passed to subsequent functions/methods.

Value

character. Identified YAML markup.

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/yamlr

See Also

processYaml, getYaml, parseYaml, buildExpressionFromYaml, updateYamlSource

Examples

## Not run: 
  
##------------------------------------------------------------------------------
## From function //
##------------------------------------------------------------------------------

## Get //  
yaml <- processYaml(
  from = function() {
    "object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}"
    ref_1 * 2
  },
  ctx = YamlContext.ObjectReference.S3()
)

## Inspect //
yaml$src
## --> note that the original YAML markup has been substituted by a 
## suitable expression for this specific context (`yaml$src$x_1$get_assign`).
## The processing is now complete and the source object can be used as is
## as it is now "self contained" in the sense that it contains all information
## that are needed in order for it to do its job.

## Actual use of the source object //
x_1 <- 10
eval(yaml$src())

## Clean up //
rm(x_1)
rm(yaml)

##------------------------------------------------------------------------------
## From expression //
##------------------------------------------------------------------------------

## Get //  
yaml <- processYaml(
  from = captureExpression({
    "object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}"
    ref_1 * 2
  }),
  ctx = YamlContext.ObjectReference.S3()
)

## Inspect //
yaml$src

## Actual use of the source object //
x_1 <- 10
eval(yaml$src)

## Clean up //
rm(x_1)
rm(yaml)


## End(Not run)

rappster/yamlr documentation built on May 27, 2019, 2:02 a.m.