getYamlFromComments-function-YamlContext.ObjectReference.S3-method: Get YAML Markup From Comments...

Description Usage Arguments Value Author(s) References See Also Examples

Description

See generic: getYamlFromComments

Usage

1
2
3
## S4 method for signature ''function',YamlContext.ObjectReference.S3'
getYamlFromComments(from,
  ctx = NULL, where = parent.frame(), ...)

Arguments

from

missing.

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.

...

Further arguments to be passed to subsequent functions/methods.

Value

character. Identified YAML markup.

Author(s)

Janko Thyson janko.thyson@rappster.de

References

http://github.com/Rappster/yamlr

See Also

getYamlFromComments, getYaml

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 

yaml <- getYamlFromComments(
  from = function() {
    ## object-ref: {id: x_1, where:.GlobalEnv, as: ref_1}
  },
  ctx = YamlContext.ObjectReference.S3()
)
yaml$original
yaml$src


## End(Not run)

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