getYaml-ANY-YamlContext.ObjectReference.S3-method: Get YAML Markup (ANY-YamlContext.ObjectReference.S3)

In rappster/yamlr: Processes YAML markup

Description

See generic: getYaml

Usage

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

Arguments

from	ANY.
ctx	YamlContext.ObjectReference.S3.
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

getYaml

Examples

## Not run: 

##------------------------------------------------------------------------------  
## As inline string //
##------------------------------------------------------------------------------

## With curly brackets //  
yaml <- getYaml(
  from = function() {
    "object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}"
    ref_1 * 2
  },
  ctx = YamlContext.ObjectReference.S3()
)
yaml
yaml$original
yaml$index
yaml$src

## W/o curly brackets //
yaml <- getYaml(
  from = function()
    "object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}",
  ctx = YamlContext.ObjectReference.S3()
)
yaml$original
yaml$original
yaml$index
yaml$src

## Expression //
yaml <- getYaml(
  from = captureExpression({
    "object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}"
    ref_1 * 2
  }),
  ctx = YamlContext.ObjectReference.S3()
)
yaml
yaml$original
yaml$index
yaml$src

## Condition handling //
yaml <- getYaml(
  from = function (){
    "Invalid YAML markup"
    ref_1 * 2
  },
  ctx = YamlContext.ObjectReference.S3()
)
yaml
yaml$original
yaml$index
yaml$src

try(getYaml(
  from = function (){
    "Invalid YAML markup"
    ref_1 * 2
  },
  ctx = YamlContext.ObjectReference.S3(),
  strict = TRUE
))

##------------------------------------------------------------------------------  
## As comment //
##------------------------------------------------------------------------------

## With curly brackets //  
yaml <- getYaml(
  from = function() {
    ## object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}
    ref_1 * 2
  },
  ctx = YamlContext.ObjectReference.S3()
)
yaml$original
yaml$index
yaml$src

## W/o curly brackets //
yaml <- getYaml(
  from = function()
    ## object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}
    ref_1 * 2,
  ctx = YamlContext.ObjectReference.S3()
)
yaml$original
yaml$index
yaml$src


## End(Not run)

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