getYamlFromComments: Get YAML Markup From Comments (generic)

In rappster/yamlr: Processes YAML markup

Description

Identifies lines that correspond to YAML markup in comments.

Usage

getYamlFromComments(from, ctx = NULL, where = parent.frame(), ...)

Arguments

from	Signature argument. Object containing YAML markup.
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.

YAML syntax

Note that the YAML statement for specifying object references must be as follows:

object-ref: {id: {id}, where: {where}, as: {id-ref}}

Note that elements where and as are optional and that spaces are required between each syntax component. While the lack of spaces will cause a parsing error in yaml.load, additional spaces do not casue any trouble.

Example for valid YAML statements

• object-ref: {id: x_1, where: .GlobalEnv, as: ref_1}

• object-ref: {id: x_1, where: .GlobalEnv}

• object-ref: {id: x_1}

• object-ref: { id: x_1, where : .GlobalEnv, as: ref_1 }

See the official http://www.yaml.org/ for more details about YAML

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/yamlr

See Also

getYamlFromComments-function-YamlContext.ObjectReference.S3-method, getYaml

Examples

## 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.