rstudio/plumber

document that local variables are ok

Open

#330 opened on Nov 2, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)R (1,437 stars) (257 forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Description

The router below works as expected.

#* @get /a
(function(){
  cat("sourced!\n")
  function() {
    valueA
  }
})()

#* @get /b
function() {
  valueA
}

valueA <- 4

It should be added to the documentation here: https://www.rplumber.io/docs/runtime.html#environments

Ref: https://github.com/trestletech/plumber/issues/329

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
R programmingPlumber basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding documentation about local variables in plumber routes, referencing the working example in the issue body. The target page is https://www.rplumber.io/docs/runtime.html#environments. The example shows that valueA is accessible inside both endpoints. The documentation should note that local variables defined outside functions are available in route handlers. See also the referenced issue #329 for context.