Regular expression for matching the function name in a completion line in the middle of a function call

Description

Regular expression for matching the function name in a completion line in the middle of a function call

Usage

.fname_regex

Format

An object of class character of length 1.

Get namespace to get access to unexported functions, namely RdTags

Description

Get namespace to get access to unexported functions, namely RdTags

Usage

.tools

Format

An object of class environment of length 792.

Get namespace to get access to unexported functions, namely .getHelpFile .assignLinebuffer .assignEnd .guessTokenFromLine .completeToken

Description

Get namespace to get access to unexported functions, namely .getHelpFile .assignLinebuffer .assignEnd .guessTokenFromLine .completeToken

Usage

.utils

Format

An object of class environment of length 576.

Enable Error Annotations for an Ace Code Input

Description

This function dynamically evaluate R for syntax errors using the parse function.

Usage

aceAnnotate(inputId, session = shiny::getDefaultReactiveDomain())

Arguments

Details

You can implement your own code completer by observing modification events to input$<editorId>_shinyAce_annotationTrigger where <editorId> is the aceEditor id. This input is only used for triggering completion and will contain a random number. However, you can access session$input[[inputId]] to get the input text for parsing.

Value

An observer reference class object that is responsible for offering code annotations. See observeEvent for more details. You can use suspend or destroy to pause to stop dynamic code completion.

The observer reference object will send a custom shiny message using session$sendCustomMessage to the annotations endpoint containing a json list of annotation metadata objects. The json list should have a structure akin to:

  [
    {
       row:  <int: row of annotation reference>,
       col:  <int: column of annotation reference>,
       type: <str: "error", "alert" or "flash">,
       html: <str: html of annotation hover div, used by default over text>,
       text: <num: text of annotation hover div>,
    }
  ]
  

Enable Code Completion for an Ace Code Input

Description

This function dynamically auto complete R code pieces using built-in functions utils:::.assignLinebuffer, utils:::.assignEnd, utils:::.guessTokenFromLine and utils:::.completeToken.

Usage

aceAutocomplete(inputId, session = shiny::getDefaultReactiveDomain())

Arguments

Details

You can implement your own code completer by listening to input$<editorId>_shinyAce_hint where <editorId> is the aceEditor id. The input contains

• linebuffer: Code/Text at current editing line

• cursorPosition: Current cursor position at this line

Value

An observer reference class object that is responsible for offering code completion. See observe for more details. You can use suspend or destroy to pause to stop dynamic code completion.

The observer reference object will send a custom shiny message using session$sendCustomMessage to the codeCompletions endpoint containing a json list of completion item metadata objects. The json list should have a structure akin to:

  [
    {
       value:        <str: value to be inserted upon completion (e.g. "print()")>,
       caption:      <str: value to be displayed (e.g. "print() # prints text")>,
       score:        <num: score to pass to ace editor for sorting>,
       meta:         <str: meta text on right of completion>
       r_symbol:     <str: symbol name of completion item>,
       r_envir_name: <str: name of the environment from which the symbol is referenced>,
       r_help_type:  <str: a datatype for dispatching help documentation function>,
       completer:    <str: used for dispatching default insertMatch functions>,
    }
  ]
  

Render Ace

Description

Render an Ace editor on an application page.

Usage

aceEditor(
  outputId,
  value,
  mode,
  theme,
  vimKeyBinding = FALSE,
  readOnly = FALSE,
  height = "400px",
  fontSize = 12,
  debounce = 1000,
  wordWrap = FALSE,
  showLineNumbers = TRUE,
  highlightActiveLine = TRUE,
  selectionId = NULL,
  cursorId = NULL,
  hotkeys = NULL,
  code_hotkeys = NULL,
  autoComplete = c("disabled", "enabled", "live"),
  autoCompleters = c("snippet", "text", "keyword"),
  autoCompleteList = NULL,
  tabSize = 4,
  useSoftTabs = TRUE,
  showInvisibles = FALSE,
  setBehavioursEnabled = TRUE,
  showPrintMargin = TRUE,
  autoScrollEditorIntoView = FALSE,
  maxLines = NULL,
  minLines = NULL,
  placeholder = NULL
)

Arguments

Author(s)

Jeff Allen jeff@trestletech.com

Examples

## Not run: 
aceEditor(
  outputId = "myEditor",
  value = "Initial text for editor here",
  mode = "r",
  theme = "ambiance"
)

aceEditor(
  outputId = "myCodeEditor",
  value = "# Enter code",
  mode = "r",
  hotkeys = list(
    helpKey = "F1",
    runKey = list(
      win = "Ctrl-R|Ctrl-Shift-Enter",
      mac = "CMD-ENTER|CMD-SHIFT-ENTER"
    )
  ),
  wordWrap = TRUE, debounce = 10
)

aceEditor(
  outputId = "mySmartEditor",
  value = "plot(wt ~ mpg, data = mtcars)",
  mode = "r",
  autoComplete = "live",
  autoCompleteList = list(mtcars = colnames(mtcars))
)

## End(Not run)

Enable Completion Tooltips for an Ace Code Input

Description

This function uses the completion item object to retrieve tooltip information by parsing R help documentation and rendering to html.

Usage

aceTooltip(inputId, session = shiny::getDefaultReactiveDomain())

Arguments

Details

You can implement your own tooltips by observing modification events to input$<editorId>_shinyAce_tooltipItem where <editorId> is the aceEditor id. This input contains the object passed to codeCompletion for this item. See the help for aceAutocomplete for details on the fields of the completion item object.

Value

An observer reference class object that is responsible for offering completion tooltips. See observe for more details. You can use suspend or destroy to pause to stop dynamic code completion.

The observer reference object will send a custom shiny message using session$sendCustomMessage to the docTooltip endpoint containing a json list of completion item metadata objects. The json list should have a structure akin to one of:

A text object

  <str: text to display for tooltip>
  

An object containing a docHTML property

  {
     docHTML: <str: html to display for tooltip div, used if available>,
  }
  

An object containing a docText property

  {
     docText: <str: text to display for tooltip div>
  }
  

Build the fields used to make an html tooltip

Description

Build the fields used to make an html tooltip

Usage

build_tooltip_fields(v)

Arguments

Value

a list with html-formatted character values "title" and "body

Get available modes

Description

Gets all of the available modes available in the installed version of shinyAce. Modes are often the programming or markup language which will be used in the editor and determine things like syntax highlighting and code folding.

Usage

getAceModes()

Author(s)

Jeff Allen jeff@trestletech.com

Get available themes

Description

Gets all of the available themes available in the installed version of shinyAce. Themes determine the styling and colors used in the editor.

Usage

getAceThemes()

Author(s)

Jeff Allen jeff@trestletech.com

Retrieve argument documentation from help document

Description

Retrieve argument documentation from help document

Usage

get_arg_help(..., args = character())

Arguments

Value

A character vector of help

Examples

shinyAce:::get_arg_help("match", package = "base", args = c("table", "nomatch"))

Retrieve description section from help document

Description

Retrieve description section from help document

Usage

get_desc_help(...)

Arguments

Value

a character value representing the description section of a help document, rendered as HTML

Examples

shinyAce:::get_desc_help("match", package = "base")

Retrieve an Rd object of a help query

Description

Safely return NULL if an error is encountered.

Usage

get_help_file(...)

Arguments

Value

the Rd object returned from utils:::getHelpFile

Retrieve usage section from help document

Description

Retrieve usage section from help document

Usage

get_usage_help(...)

Arguments

Value

a character value representing the usage section of a help document, rendered as HTML

Examples

shinyAce:::get_usage_help("match", package = "base")

Check if vector is empty

Description

Check if vector is empty

Usage

is.empty(x)

Arguments

Examples

is.empty(NULL)
is.empty(NA)
is.empty(c())
is.empty("")
is.empty(" ")
is.empty(c(" ", " "))
is.empty(list())
is.empty(list(a = "", b = ""))

Character value to use for object meta field

Description

Character value to use for object meta field

Usage

meta_obj()

Character value to use for package meta field

Description

Character value to use for package meta field

Usage

meta_pkg()

R completions when cursor is within a function call

Description

R completions when cursor is within a function call

Usage

r_completions_function_call_metadata(fname, completions)

Arguments

R completions for general case

Description

R completions for general case

Usage

r_completions_general_metadata(completions)

Arguments

Return completions for a given line of text

Description

Return completions for a given line of text

Usage

r_completions_metadata(line)

Arguments

Convert an Rd object to HTML

Description

Convert an Rd object to HTML

Usage

rd_2_html(...)

Arguments

Value

a character value of Rd content rendered as HTML

Retrieve regular expression named capture groups as a list

Description

Retrieve regular expression named capture groups as a list

Usage

re_capture(x, re, ...)

Arguments

Value

a named list of matches

Examples

shinyAce:::re_capture("ak09j b", "(?<num>\\d+)(?<alpha>[a-zA-Z]+)", perl = TRUE)

Options available for shinyAce

Description

shinyAce.debug

Logical value to enable or disable debugging messages being printed to console. default behavior equivalent to FALSE.

Function for handling optional debugging messages

Description

Function for handling optional debugging messages

Usage

shinyAce_debug(...)

Arguments

A helper for formatting a tooltip entry

Description

A helper for formatting a tooltip entry

Usage

tooltip_html(title = "", body = "")

Arguments

Update Ace Editor

Description

Update the styling or mode of an aceEditor component.

Usage

updateAceEditor(
  session,
  editorId,
  value,
  theme,
  readOnly,
  mode,
  fontSize,
  showLineNumbers,
  wordWrap,
  useSoftTabs,
  tabSize,
  showInvisibles,
  showPrintMargin,
  border = c("normal", "alert", "flash"),
  autoComplete = c("disabled", "enabled", "live"),
  autoCompleters = c("snippet", "text", "keyword", "static", "rlang"),
  autoCompleteList = NULL
)

Arguments

Author(s)

Jeff Allen jeff@trestletech.com

Examples

## Not run: 
 shinyServer(function(input, output, session) {
   observe({
     updateAceEditor(session, "myEditor", "Updated text for editor here",
       mode = "r", theme = "ambiance")
   })
 }

## End(Not run)