plotly / plotly/plotly.R

Translate JSON references in docs to R equivalents

Open
#439 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
R
Stars
2.7k
Forks
641
PR merge metrics
No merged PRs in 30d

Description

Is this an error in the documentation for R? This is for heatmap > colorscale section link:

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]. To control the bounds of the colorscale in z space, use zmin and amax

Two things, first it's missing a ']'. That's far less important as you can't feed R an array using that syntax. If I take the example from the site:

plot_ly(z = volcano, type = "heatmap")

And I create a var called 'colScale' to add a custom colorscale value, then this (going by the documentation) won't work:

colScale = [[0, 'rgb(10,0,50)'], [1, '#rgb(50,100,10)']]

It gives me an error (in R itself, not in the attempt to draw the plot). If I make a list and add it to the sample it works:

colScale= list(c(0, "rgb(10,0,50)"),list(1, "rgb(50,100,10)"))
plot_ly(z = volcano, type = "heatmap" , colorscale = colScale)

Using a simple 'Find' command it looks like there are multiple instances of the array syntax in the R documentation on the site.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked heatmap colorscale reference and search the R documentation for the reported array syntax. Update the affected examples to valid R equivalents, including the heatmap colorscale example, and confirm that the documentation no longer presents JSON-style arrays as R code.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.