Skip to contents

Generate an Empty Plotly Object

Source: R/utils.R
parse_annotation.Rd

This function returns a blank Plotly plot with optional annotation text. It ensures that when no valid data is available, a meaningful placeholder plot is displayed instead of causing an error.

Usage

parse_annotation(data, text)

Arguments

data

Data frame containing data to reference. Should include columns and labels referenced in the text string. Referenced variables should be able to produce single unique result.

text

Character text to parse.

Value

Parsed annotation text.

Details

Parses annotations in the context of data. Special characters and syntax are substituted by actual data and/or substituted for format that is better parsed via rendering functions (e.g. plotly).

  • \n character is substituted for <br> tag in order to add new lines in rendered image.

  • $COLNAME is parsed to provide unique data value from the mentioned column.

  • !COLNAME is parsed to provide label attribute for a given column name. If any values are missing from the provided data, they are substituted for ERR string.