plotly / plotly/plotly.R

Translate JSON references in docs to R equivalents

オープン
#439 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンクされた heatmap colorscale のリファレンスから始め、報告された配列構文を R のドキュメントで検索します。影響を受ける例を有効な R の同等表現に更新し、heatmap colorscale の例も含め、ドキュメントが JSON 形式の配列を R コードとして示さなくなったことを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
r
領域
data-visualization, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。