From 275f60109c9e7191d4f5dd21f53374a56799bb1b Mon Sep 17 00:00:00 2001 From: Joseph Damiba Date: Thu, 16 Jan 2020 11:57:17 -0500 Subject: [PATCH 1/5] update getting-started and create getting-started-with-chart-studio --- r/2015-07-30-getting-started.Rmd | 4 +- ...1-16-getting-started-with-chart-studio.Rmd | 116 ++++++++++++++++++ 2 files changed, 117 insertions(+), 3 deletions(-) create mode 100644 r/2020-01-16-getting-started-with-chart-studio.Rmd diff --git a/r/2015-07-30-getting-started.Rmd b/r/2015-07-30-getting-started.Rmd index 2f12eabc..6a8b1412 100644 --- a/r/2015-07-30-getting-started.Rmd +++ b/r/2015-07-30-getting-started.Rmd @@ -41,7 +41,7 @@ RStudio users should download the latest [RStudio release](https://www.rstudio.c By default, Plotly for R runs locally in your web browser or in the R Studio viewer. -```r +```{r} library(plotly) p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") p @@ -49,8 +49,6 @@ p Simply printing the Plotly object will render the chart locally in your web browser or in the R Studio viewer. - - Plotly graphs are interactive. Click on legend entries to toggle traces, click-and-drag on the chart to zoom, double-click to autoscale, shift-and-drag to pan. #### Initialization for Online Plotting diff --git a/r/2020-01-16-getting-started-with-chart-studio.Rmd b/r/2020-01-16-getting-started-with-chart-studio.Rmd new file mode 100644 index 00000000..d8a2616a --- /dev/null +++ b/r/2020-01-16-getting-started-with-chart-studio.Rmd @@ -0,0 +1,116 @@ +--- +name: Getting Started with Chart Studio +permalink: r/getting-started-with-chart-studio/ +description: Get started with Chart Studio and Plotly's R graphing library. +page_type: example_index +layout: base +language: r +output: + html_document: + keep_md: true +--- + +```{r, echo = FALSE, message=FALSE} +knitr::opts_chunk$set(message = FALSE, warning=FALSE) +``` + +# Getting Started with Chart Studio and the `plotly` R Package + +`plotly` is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [plotly.js](http://plot.ly/javascript). + +As of version 2.0 (November 17, 2015), R graphs created with the `plotly` R package are rendered *locally* through the [htmlwidgets](http://www.htmlwidgets.org/) framework. + +#### Initialization for Online Plotting + +You can choose to publish charts you create with the `plotly` R package to the web using the Chart Studio web service. + +1 - [Create a free Chart Studio account](https://plot.ly/api_signup):
+A Chart Studio account is required to publish R charts with Chart Studio. It's free to get started, and you control the privacy of your charts. + +2 - Save your authentication credentials
+Find your authentication API keys [in your online settings](https://plot.ly/settings/api). Set them in your R session with: + +```r +Sys.setenv("plotly_username"="your_plotly_username") +Sys.setenv("plotly_api_key"="your_api_key") +``` + +Save these commands in your [.Rprofile](http://www.statmethods.net/interface/customizing.html) file to be run every time you start R. + +3 - Publish your graphs to Chart Studio with `api_create` + +Use the `filename` attribute to set the title of the file that will be generated in your Chart Studio account. + +```r +library(plotly) +p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") +api_create(p, filename = "r-docs-midwest-boxplots") +``` + +4 (optional) - Suppress auto open + +When following the instructions above, `api_create(p)` will auto open the created URL in the browser. To suppress this behavior, set the `browser` option to `false` in your R session: + +```r +options(browser = 'false') +api_create(p, filename = "r-docs-midwest-boxplots") +``` + +#### Special Instructions for Chart Studio Enterprise Users + +Your API key for account on the public cloud will be different than the API key in [Chart Studio Enterprise](https://plot.ly/product/enterprise/). + +Visit to find your Chart Studio Enterprise API key. + +Remember to replace "your-company.com" with the URL of your Chart Studio Enterprise server. + +If your company has a Chart Studio Enterprise server, then you need to change the R API endpoint so that it points to your company's Chart Studio Enterprise. + +In your .RProfile, write: + +```r +Sys.setenv("plotly_domain"="https://plotly.your-company.com") +``` + +Remember to replace "your-company" with the URL of your Chart Studio Enterprise server. + +
+ Make your first graph +
+ +#### Chart Studio Plot Privacy Modes + +Chart Studio plots can be set to three different type of privacy modes: `public`, `private`, or `secret`. + +* **public:** + + Anyone can view this graph. + It will appear in your Chart Studio profile and can be indexed by search engines. + Being logged in to a Chart Studio account is not required to view this chart. + +* **private:** + + Only you can view this plot. + It will not appear in the public Chart Studio feed, your Chart Studio profile, or be indexed by search engines. + Being logged into your Chart Studio account is required to view this graph. + You can privately share this graph with other Chart Studio users. They will also need to be logged in to their Chart Studio account to view this plot. + This option is only available to Chart Studio Enterprise subscribers. + +* **secret:** + + Anyone with this secret link can view this chart. + It will not appear in the public Chart Studio feed, your Chart Studio profile, or be indexed by search engines. + If it is embedded inside a webpage or an IPython notebook, anybody who is viewing that page will be able to view the graph. + You do not need to be logged in to your Chart Studio account view this plot. + This option is only available to Chart Studio Enterprise subscribers. + +By default all Chart Studio plots you create with the `plotly` R package are set to `public`. Users with free Chart Studio accounts are limited to creating `public` plots. + +If you have private storage needs, please learn more about [Chart Studio Enterprise](https://plot.ly/online-chart-maker/). + +If you're a [Chart Studio Enterprise subscriber](https://plot.ly/settings/subscription/?modal=true&utm_source=api-docs&utm_medium=support-oss) and would like the setting for your plots to be private, you can specify sharing as private: + +```r +api_create(filename = "private-graph", sharing = "private") +``` +For more information regarding the privacy of plots published to Chart Studio using the `plotly` R package, please visit [our Chart Studio privacy documentation](https://plot.ly/r/privacy/) From 1cc614a701a721a523e38bf640a32402edfef2de Mon Sep 17 00:00:00 2001 From: Joseph Damiba Date: Thu, 16 Jan 2020 13:38:57 -0500 Subject: [PATCH 2/5] adding api key to file-names.rmd so it will pass ci --- r/2015-07-30-filenames.Rmd | 61 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 r/2015-07-30-filenames.Rmd diff --git a/r/2015-07-30-filenames.Rmd b/r/2015-07-30-filenames.Rmd new file mode 100644 index 00000000..520b4abc --- /dev/null +++ b/r/2015-07-30-filenames.Rmd @@ -0,0 +1,61 @@ +--- +description: How to update Chart Studio graphs in R. +display_as: chart_studio +language: r +layout: base +name: Updating Chart Studio Graphs +order: 1 +output: + html_document: + keep_md: true +page_type: example_index +permalink: r/file-options/ +thumbnail: thumbnail/horizontal-bar.jpg +--- + +```{r, echo = FALSE, message=FALSE} +knitr::opts_chunk$set(message = FALSE, warning=FALSE) +Sys.setenv("plotly_username"="RPlotBot") +Sys.setenv("plotly_api_key"="q0lz6r5efr") +``` +### New to Plotly? + +Plotly's R library is free and open source!
+[Get started](https://plot.ly/r/getting-started/) by downloading the client and [reading the primer](https://plot.ly/r/getting-started/).
+You can set up Plotly to work in [online](https://plot.ly/r/getting-started/#hosting-graphs-in-your-online-plotly-account) or [offline](https://plot.ly/r/offline/) mode.
+We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/r_cheat_sheet.pdf) (new!) to help you get started! + +### Version Check + +Version 4 of Plotly's R package is now [available](https://plot.ly/r/getting-started/#installation)!
+Check out [this post](http://moderndata.plot.ly/upgrading-to-plotly-4-0-and-above/) for more information on breaking changes and new features available in this version. +```{r} +library(plotly) +packageVersion('plotly') +``` + +#### Save Plot to Chart Studio +To create a Chart Studio figure, use the `api_create()` function. + +```{r} +library(plotly) +p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length) +api_create(p) +``` + +#### Overwrite Plot + +If you don't include a filename, a new plot will be made on your online plotly account. If you want to overwrite a plot (i.e., keep the graph served from the same plotly URL), specify a filename. This implicitly overwrites your plotly graph. + +```{r} +api_create(p, filename = "name-of-my-plotly-file") +``` + +#### Save your Plot in a Folder +If the filename contains "/", it will automatically create a folder in your Chart Studio account. This option is only available for [Chart Studio Enterprise subscripbers](https://plot.ly/online-chart-maker/) + +```{r} +api_create(p, filename="r-docs/name-of-my-chart-studio-file") +``` + +View your Chart Studio graphs at [https://plot.ly/organize](https://plot.ly/organize). From 4dfc94ab7d866b1eafc72fa37928877435c95171 Mon Sep 17 00:00:00 2001 From: Joseph Damiba Date: Thu, 16 Jan 2020 14:58:18 -0500 Subject: [PATCH 3/5] language fixups --- r/2015-07-30-filenames.Rmd | 61 ------------------ r/2015-07-30-getting-started.Rmd | 105 +++---------------------------- 2 files changed, 7 insertions(+), 159 deletions(-) delete mode 100644 r/2015-07-30-filenames.Rmd diff --git a/r/2015-07-30-filenames.Rmd b/r/2015-07-30-filenames.Rmd deleted file mode 100644 index 520b4abc..00000000 --- a/r/2015-07-30-filenames.Rmd +++ /dev/null @@ -1,61 +0,0 @@ ---- -description: How to update Chart Studio graphs in R. -display_as: chart_studio -language: r -layout: base -name: Updating Chart Studio Graphs -order: 1 -output: - html_document: - keep_md: true -page_type: example_index -permalink: r/file-options/ -thumbnail: thumbnail/horizontal-bar.jpg ---- - -```{r, echo = FALSE, message=FALSE} -knitr::opts_chunk$set(message = FALSE, warning=FALSE) -Sys.setenv("plotly_username"="RPlotBot") -Sys.setenv("plotly_api_key"="q0lz6r5efr") -``` -### New to Plotly? - -Plotly's R library is free and open source!
-[Get started](https://plot.ly/r/getting-started/) by downloading the client and [reading the primer](https://plot.ly/r/getting-started/).
-You can set up Plotly to work in [online](https://plot.ly/r/getting-started/#hosting-graphs-in-your-online-plotly-account) or [offline](https://plot.ly/r/offline/) mode.
-We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/r_cheat_sheet.pdf) (new!) to help you get started! - -### Version Check - -Version 4 of Plotly's R package is now [available](https://plot.ly/r/getting-started/#installation)!
-Check out [this post](http://moderndata.plot.ly/upgrading-to-plotly-4-0-and-above/) for more information on breaking changes and new features available in this version. -```{r} -library(plotly) -packageVersion('plotly') -``` - -#### Save Plot to Chart Studio -To create a Chart Studio figure, use the `api_create()` function. - -```{r} -library(plotly) -p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length) -api_create(p) -``` - -#### Overwrite Plot - -If you don't include a filename, a new plot will be made on your online plotly account. If you want to overwrite a plot (i.e., keep the graph served from the same plotly URL), specify a filename. This implicitly overwrites your plotly graph. - -```{r} -api_create(p, filename = "name-of-my-plotly-file") -``` - -#### Save your Plot in a Folder -If the filename contains "/", it will automatically create a folder in your Chart Studio account. This option is only available for [Chart Studio Enterprise subscripbers](https://plot.ly/online-chart-maker/) - -```{r} -api_create(p, filename="r-docs/name-of-my-chart-studio-file") -``` - -View your Chart Studio graphs at [https://plot.ly/organize](https://plot.ly/organize). diff --git a/r/2015-07-30-getting-started.Rmd b/r/2015-07-30-getting-started.Rmd index 6a8b1412..4ddd1965 100644 --- a/r/2015-07-30-getting-started.Rmd +++ b/r/2015-07-30-getting-started.Rmd @@ -1,7 +1,7 @@ --- name: Getting Started with Plotly permalink: r/getting-started/ -description: Get started with Plotly's graphing library +description: Get started with Plotly's R graphing library. page_type: example_index layout: base language: r @@ -16,19 +16,19 @@ knitr::opts_chunk$set(message = FALSE, warning=FALSE) # Getting Started with Plotly for R -Plotly is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [plotly.js](http://plot.ly/javascript). +`plotly` is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [plotly.js](http://plot.ly/javascript). As of version 2.0 (November 17, 2015), Plotly graphs are rendered *locally* through the [htmlwidgets](http://www.htmlwidgets.org/) framework. #### Installation -Plotly is now on CRAN! +[`plotly`](https://cran.r-project.org/web/packages/plotly/index.html) is now on [CRAN](https://cran.r-project.org/! ```r install.packages("plotly") ``` -Or install the latest development version (on GitHub) via devtools: +Or install the latest development version (on GitHub) via the devtools R package: ```r devtools::install_github("ropensci/plotly") @@ -39,7 +39,7 @@ RStudio users should download the latest [RStudio release](https://www.rstudio.c #### Initialization for Offline Plotting -By default, Plotly for R runs locally in your web browser or in the R Studio viewer. +By default, the `plotly` R package runs locally in your web browser or in the R Studio viewer. ```{r} library(plotly) @@ -47,97 +47,6 @@ p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") p ``` -Simply printing the Plotly object will render the chart locally in your web browser or in the R Studio viewer. +Simply printing the plot object will render the chart locally in your web browser or in the R Studio viewer. -Plotly graphs are interactive. Click on legend entries to toggle traces, click-and-drag on the chart to zoom, double-click to autoscale, shift-and-drag to pan. - -#### Initialization for Online Plotting - -You can publish your charts to the web with Plotly's web service. - -1 - [Create a free Plotly account](https://plot.ly/api_signup):
-A Plotly account is required to publish charts online. It's free to get started, and you control the privacy of your charts. - -2 - Save your authentication credentials
-Find your authentication API keys [in your online settings](https://plot.ly/settings/api). Set them in your R session with: - -```r -Sys.setenv("plotly_username"="your_plotly_username") -Sys.setenv("plotly_api_key"="your_api_key") -``` - -Save these commands in your [.Rprofile](http://www.statmethods.net/interface/customizing.html) file to be run every time you start R. - -3 - Publish your graphs to Plotly with `api_create` - -Use `filename` to title the file in your Plotly account. - -```r -library(plotly) -p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") -api_create(p, filename = "r-docs-midwest-boxplots") -``` - -4 (optional) - Suppress auto open - -When following the instructions above, `api_create(p)` will auto open the created URL in the browser. To suppress this behavior, you can update your browser options in R: - -```r -options(browser = 'false') -api_create(p, filename = "r-docs-midwest-boxplots") -``` - -#### Special Instructions for Chart Studio Enterprise Users - -Your API key for account on the public cloud will be different than the API key in [Chart Studio Enterprise](https://plot.ly/product/enterprise/). Visit to find your Chart Studio Enterprise API key. Remember to replace "your-company.com" with the URL of your Chart Studio Enterprise server. - -If your company has a Chart Studio Enterprise server, change the R API endpoint so that it points to your company's Plotly server instead of Plotly's cloud. - -In your .RProfile write: - -```r -Sys.setenv("plotly_domain"="https://plotly.your-company.com") -``` - -Remember to replace "your-company" with the URL of your Chart Studio Enterprise server. - -
- Make your first graph -
- -#### Online Plot Privacy - -Plots can be set to three different type of privacies: public, private or secret. - -* **public:** - - Anyone can view this graph. It will appear in your profile - and can appear in search engines. You do not need to be - logged in to Plotly to view this chart. - -* **private:** - - Only you can view this plot. It will not appear in the - Plotly feed, your profile, or search engines. You must be - logged in to Plotly to view this graph. You can privately - share this graph with other Plotly users in your online - Plotly account and they will need to be logged in to - view this plot. This option is only available for Personal - and Professional subscribers. - -* **secret:** - - Anyone with this secret link can view this chart. It will - not appear in the Plotly feed, your profile, or search - engines. If it is embedded inside a webpage or an IPython - notebook, anybody who is viewing that page will be able to - view the graph. You do not need to be logged in to view - this plot. This option is only available for Personal - and Professional subscribers. - -By default all plots are set to public. Users with a free account are limited to creating public plots. If you have private storage needs, please visit [Plotly products page](https://plot.ly/products). If you're a [Personal or Professional USER](https://plot.ly/settings/subscription/?modal=true&utm_source=api-docs&utm_medium=support-oss) and would like the setting for your plots to be private, you can specify sharing as private: - -```r -api_create(filename = "private-graph", sharing = "private") -``` -For more examples on privacy settings please visit [R privacy documentation](https://plot.ly/r/privacy/) +Graphs created with the `plotly` R package are interactive. Click on legend entries to toggle traces, click-and-drag on the chart to zoom, double-click to autoscale, shift-and-drag to pan. \ No newline at end of file From 7ddb02b1b4471fff72053b35ceeaee7ac050091d Mon Sep 17 00:00:00 2001 From: Joseph Damiba Date: Fri, 17 Jan 2020 14:43:48 -0500 Subject: [PATCH 4/5] update getting-started.md --- r/2015-07-30-getting-started.Rmd | 35 ++++-- ...1-16-getting-started-with-chart-studio.Rmd | 116 ------------------ 2 files changed, 23 insertions(+), 128 deletions(-) delete mode 100644 r/2020-01-16-getting-started-with-chart-studio.Rmd diff --git a/r/2015-07-30-getting-started.Rmd b/r/2015-07-30-getting-started.Rmd index 4ddd1965..3276c2b1 100644 --- a/r/2015-07-30-getting-started.Rmd +++ b/r/2015-07-30-getting-started.Rmd @@ -1,7 +1,7 @@ --- name: Getting Started with Plotly permalink: r/getting-started/ -description: Get started with Plotly's R graphing library. +description: How to get started making charts with Plotly's R graphing library. page_type: example_index layout: base language: r @@ -16,30 +16,35 @@ knitr::opts_chunk$set(message = FALSE, warning=FALSE) # Getting Started with Plotly for R -`plotly` is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [plotly.js](http://plot.ly/javascript). -As of version 2.0 (November 17, 2015), Plotly graphs are rendered *locally* through the [htmlwidgets](http://www.htmlwidgets.org/) framework. +[`plotly`](https://github.com/ropensci/plotly) is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [`plotly.js`](http://plot.ly/javascript). +As of version 2.0 (November 17, 2015), graphs created with the `plotly` R package are rendered *locally* through the [`htmlwidgets`](http://www.htmlwidgets.org/) framework. -#### Installation +## Installation -[`plotly`](https://cran.r-project.org/web/packages/plotly/index.html) is now on [CRAN](https://cran.r-project.org/! +### Download from CRAN + +Use the `install.package()` function to install the [`plotly R package`](https://cran.r-project.org/web/packages/plotly/index.html) from [CRAN](https://cran.r-project.org/! ```r install.packages("plotly") ``` -Or install the latest development version (on GitHub) via the devtools R package: +### Download from GitHub + +Alternatively, you can install the latest development version of `plotly` from GitHub via the [`devtools`](https://cran.r-project.org/web/packages/devtools/index.html) R package: ```r devtools::install_github("ropensci/plotly") ``` -
-RStudio users should download the latest [RStudio release](https://www.rstudio.com/products/rstudio/download/) for compatibility with htmlwidgets. +### Note For `RStudio` Users + +`RStudio` users should ensure that they are using the latest [RStudio release](https://www.rstudio.com/products/rstudio/download/) in order to ensure compatibility with the `htmlwidgets` R package. -#### Initialization for Offline Plotting +## Rendering Charts -By default, the `plotly` R package runs locally in your web browser or in the R Studio viewer. +By default, the `plotly` R package runs locally in your web browser or in the ` viewer. ```{r} library(plotly) @@ -47,6 +52,12 @@ p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") p ``` -Simply printing the plot object will render the chart locally in your web browser or in the R Studio viewer. +Simply printing the plot object will render the chart locally in your web browser or in the `RStudio` viewer. + +Graphs created with the `plotly` R package are interactive! + +Click on legend entries to hide/show traces, click-and-drag on the chart to zoom, double-click to autoscale, shift-and-drag to pan. + +## Next Steps -Graphs created with the `plotly` R package are interactive. Click on legend entries to toggle traces, click-and-drag on the chart to zoom, double-click to autoscale, shift-and-drag to pan. \ No newline at end of file +Once you have installed the `plotly` R package, learn more about the [fundamentals of making charts](https://plot.ly/r/plotly-fundamentals/) and start making [basic charts](https://plot.ly/r/basic-charts/). \ No newline at end of file diff --git a/r/2020-01-16-getting-started-with-chart-studio.Rmd b/r/2020-01-16-getting-started-with-chart-studio.Rmd deleted file mode 100644 index d8a2616a..00000000 --- a/r/2020-01-16-getting-started-with-chart-studio.Rmd +++ /dev/null @@ -1,116 +0,0 @@ ---- -name: Getting Started with Chart Studio -permalink: r/getting-started-with-chart-studio/ -description: Get started with Chart Studio and Plotly's R graphing library. -page_type: example_index -layout: base -language: r -output: - html_document: - keep_md: true ---- - -```{r, echo = FALSE, message=FALSE} -knitr::opts_chunk$set(message = FALSE, warning=FALSE) -``` - -# Getting Started with Chart Studio and the `plotly` R Package - -`plotly` is an R package for creating interactive web-based graphs via the open source JavaScript graphing library [plotly.js](http://plot.ly/javascript). - -As of version 2.0 (November 17, 2015), R graphs created with the `plotly` R package are rendered *locally* through the [htmlwidgets](http://www.htmlwidgets.org/) framework. - -#### Initialization for Online Plotting - -You can choose to publish charts you create with the `plotly` R package to the web using the Chart Studio web service. - -1 - [Create a free Chart Studio account](https://plot.ly/api_signup):
-A Chart Studio account is required to publish R charts with Chart Studio. It's free to get started, and you control the privacy of your charts. - -2 - Save your authentication credentials
-Find your authentication API keys [in your online settings](https://plot.ly/settings/api). Set them in your R session with: - -```r -Sys.setenv("plotly_username"="your_plotly_username") -Sys.setenv("plotly_api_key"="your_api_key") -``` - -Save these commands in your [.Rprofile](http://www.statmethods.net/interface/customizing.html) file to be run every time you start R. - -3 - Publish your graphs to Chart Studio with `api_create` - -Use the `filename` attribute to set the title of the file that will be generated in your Chart Studio account. - -```r -library(plotly) -p <- plot_ly(midwest, x = ~percollege, color = ~state, type = "box") -api_create(p, filename = "r-docs-midwest-boxplots") -``` - -4 (optional) - Suppress auto open - -When following the instructions above, `api_create(p)` will auto open the created URL in the browser. To suppress this behavior, set the `browser` option to `false` in your R session: - -```r -options(browser = 'false') -api_create(p, filename = "r-docs-midwest-boxplots") -``` - -#### Special Instructions for Chart Studio Enterprise Users - -Your API key for account on the public cloud will be different than the API key in [Chart Studio Enterprise](https://plot.ly/product/enterprise/). - -Visit to find your Chart Studio Enterprise API key. - -Remember to replace "your-company.com" with the URL of your Chart Studio Enterprise server. - -If your company has a Chart Studio Enterprise server, then you need to change the R API endpoint so that it points to your company's Chart Studio Enterprise. - -In your .RProfile, write: - -```r -Sys.setenv("plotly_domain"="https://plotly.your-company.com") -``` - -Remember to replace "your-company" with the URL of your Chart Studio Enterprise server. - -
- Make your first graph -
- -#### Chart Studio Plot Privacy Modes - -Chart Studio plots can be set to three different type of privacy modes: `public`, `private`, or `secret`. - -* **public:** - - Anyone can view this graph. - It will appear in your Chart Studio profile and can be indexed by search engines. - Being logged in to a Chart Studio account is not required to view this chart. - -* **private:** - - Only you can view this plot. - It will not appear in the public Chart Studio feed, your Chart Studio profile, or be indexed by search engines. - Being logged into your Chart Studio account is required to view this graph. - You can privately share this graph with other Chart Studio users. They will also need to be logged in to their Chart Studio account to view this plot. - This option is only available to Chart Studio Enterprise subscribers. - -* **secret:** - - Anyone with this secret link can view this chart. - It will not appear in the public Chart Studio feed, your Chart Studio profile, or be indexed by search engines. - If it is embedded inside a webpage or an IPython notebook, anybody who is viewing that page will be able to view the graph. - You do not need to be logged in to your Chart Studio account view this plot. - This option is only available to Chart Studio Enterprise subscribers. - -By default all Chart Studio plots you create with the `plotly` R package are set to `public`. Users with free Chart Studio accounts are limited to creating `public` plots. - -If you have private storage needs, please learn more about [Chart Studio Enterprise](https://plot.ly/online-chart-maker/). - -If you're a [Chart Studio Enterprise subscriber](https://plot.ly/settings/subscription/?modal=true&utm_source=api-docs&utm_medium=support-oss) and would like the setting for your plots to be private, you can specify sharing as private: - -```r -api_create(filename = "private-graph", sharing = "private") -``` -For more information regarding the privacy of plots published to Chart Studio using the `plotly` R package, please visit [our Chart Studio privacy documentation](https://plot.ly/r/privacy/) From a635477bd33a7d9723967eb0706523b266d3046a Mon Sep 17 00:00:00 2001 From: Joseph Damiba Date: Fri, 17 Jan 2020 15:48:06 -0500 Subject: [PATCH 5/5] fix typo --- r/2015-07-30-getting-started.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/r/2015-07-30-getting-started.Rmd b/r/2015-07-30-getting-started.Rmd index 3276c2b1..04619dd1 100644 --- a/r/2015-07-30-getting-started.Rmd +++ b/r/2015-07-30-getting-started.Rmd @@ -44,7 +44,7 @@ devtools::install_github("ropensci/plotly") ## Rendering Charts -By default, the `plotly` R package runs locally in your web browser or in the ` viewer. +By default, the `plotly` R package runs locally in your web browser or in the `RStudio` viewer. ```{r} library(plotly)