plotly / plotly/plotly.R

Translate JSON references in docs to R equivalents

未關閉
#439 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

documentation
主要語言
R
星號
2.7k
分支
641
PR 合併指標
30 天內沒有已合併 PR

描述

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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從連結的 heatmap colorscale 參考資料開始,並在 R 文件中搜尋回報的陣列語法。將受影響的範例更新為有效的 R 等效寫法,包括 heatmap colorscale 範例,並確認文件不再將 JSON 風格的陣列表示為 R 程式碼。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
r
領域
data-visualization, documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。