diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index ccda1daf7cfd..000000000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,118 +0,0 @@ -version: 2 -jobs: - build: - branches: - ignore: - - gh-pages - - docker: - # a packaged system that has the instructions for creating a running container. - - image: circleci/ruby:2.3.3 - - # actions that need to be taken to perform your job - steps: - - add_ssh_keys: - fingerprints: - - "dc:5f:39:48:00:b4:72:34:e1:d2:c4:e1:1f:d1:e2:ce" #plotlydocbot - - - restore_cache: - keys: - - source-v1- #one time, not every time! - - # checks out the source code for a job over SSH - - checkout - - - save_cache: - key: source-v1-1 # Sept 7, 2019 - paths: - - ".git" - - - restore_cache: - keys: - - gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }} - - gem-cache-v1-{{ arch }}-{{ .Branch }} - - gem-cache-v1 - - - run: - name: install dependencies - command: | - bundle install --path vendor/bundle - sudo apt-get update - sudo apt install python-pip - sudo pip install python-frontmatter - sudo pip install pathlib - - - save_cache: - key: gem-cache-v1-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }} - paths: - - vendor/bundle - - - run: - name: deployment - command: | - git config --global user.email "accounts@plot.ly" - git config --global user.name "plotlydocbot" - echo - echo "token: ${mapbox_token}" > _data/mapbox_token.yml - rm -rf _posts/python/html - rm -rf _posts/r/md - git clone -b built git@github.com:plotly/plotly.py-docs _posts/python/html - git clone -b built git@github.com:plotly/plotly.r-docs _posts/r/md - mv _posts/r/md/ggplot2 _posts/ggplot2/md - python front-matter-ci.py _posts - python check-or-enforce-order.py _posts/python - python check-or-enforce-order.py _posts/python-v3 - python check-or-enforce-order.py _posts/r/ - python check-or-enforce-order.py _posts/plotly_js - bundle exec jekyll build - rm _data/mapbox_token.yml - mkdir snapshots - cd _site - cp -r 'all_static' '../snapshots' - cp 'api/index.html' '../snapshots' - cp --parents 'python/index.html' '../snapshots' - cp --parents 'python/getting-started/index.html' '../snapshots' - cp --parents 'python/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'python/line-and-scatter/index.html' '../snapshots' - cp --parents 'r/index.html' '../snapshots' - cp --parents 'r/getting-started/index.html' '../snapshots' - cp --parents 'r/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'r/line-and-scatter/index.html' '../snapshots' - cp --parents 'javascript/index.html' '../snapshots' - cp --parents 'javascript/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'javascript/getting-started/index.html' '../snapshots' - cp --parents 'javascript/line-and-scatter/index.html' '../snapshots' - cp --parents 'ggplot2/index.html' '../snapshots' - cp --parents 'ggplot2/getting-started/index.html' '../snapshots' - cp --parents 'ggplot2/geom_abline/index.html' '../snapshots' - cp --parents 'python/v3/index.html' '../snapshots' - cp --parents 'python/v3/plotly-fundamentals/index.html' '../snapshots' - cp --parents 'python/v3/getting-started/index.html' '../snapshots' - cp --parents 'python/v3/line-and-scatter/index.html' '../snapshots' - cp --parents 'matlab/index.html' '../snapshots' - cp --parents 'matlab/getting-started/index.html' '../snapshots' - cp --parents 'matlab/graphing-multiple-chart-types/index.html' '../snapshots' - cp --parents 'matlab/scatter/index.html' '../snapshots' - cd .. - rm -f 'snapshots/all_static/javascripts/jquery-knob/index.html' - rm -f 'snapshots/all_static/images/Plotly-feed2.html' - rm -f 'snapshots/all_static/images/Plotly.html' - rm -f 'snapshots/all_static/images/Plotly-Feed.html' - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*.html - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*.html - sed -i.bkp 's/drift\.load/console\.log/g' snapshots/*/*/*.html - rm -f snapshots/*.bkp - rm -f snapshots/*/*.bkp - rm -f snapshots/*/*/*.bkp - percy snapshot snapshots --enable_javascript - rm -rf 'snapshots/' - if [ "${CIRCLE_BRANCH}" == "source-design-merge" ]; then - git checkout gh-pages - git pull origin gh-pages - cp -r _site/* . - rm -rf _site/ - touch .nojekyll - git add . - git commit -m "deploying https://github.com/plotly/documentation/commit/${CIRCLE_SHA1}" - git push origin gh-pages - fi diff --git a/Rakefile b/Rakefile index 3ad04be7df8b..a1c0fc076005 100755 --- a/Rakefile +++ b/Rakefile @@ -31,6 +31,7 @@ task :serve => [] do puts "...getting latest python docs" system "rm -rf _posts/python/html" or exit!(1) system "rm -rf _posts/r/md" or exit!(1) + system "rm -rf _posts/ggplot2/md/ggplot2" or exit!(1) system "git clone -b built git@github.com:plotly/plotly.py-docs _posts/python/html" or exit!(1) system "git clone -b built git@github.com:plotly/plotly.r-docs _posts/r/md" or exit!(1) system "mv _posts/r/md/ggplot2 _posts/ggplot2/md" or exit!(1) diff --git a/_includes/layouts/new-to-plotly.html b/_includes/layouts/new-to-plotly.html new file mode 100644 index 000000000000..cddac95fe624 --- /dev/null +++ b/_includes/layouts/new-to-plotly.html @@ -0,0 +1,13 @@ + +{% if page.language == "python" or page.language == "plotly_js" or page.language == "r" or page.language == "ggplot2" %} +
+ New to Plotly? + {% if page.language == "python" %} +

Plotly is a free and open-source graphing library for Python. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% elsif page.language == "plotly_js" %} +

Plotly is a free and open-source graphing library for JavaScript. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% elsif page.language == "r" or page.language == "ggplot2" %} +

Plotly is a free and open-source graphing library for R. We recommend you read our Getting Started guide for the latest installation or upgrade instructions, then move on to our Plotly Fundamentals tutorials or dive straight in to some Basic Charts tutorials.

+ {% endif %} +
+{% endif %} diff --git a/_layouts/base.html b/_layouts/base.html index f055ed529035..253d3a563c67 100644 --- a/_layouts/base.html +++ b/_layouts/base.html @@ -61,7 +61,7 @@
-
+
@@ -114,6 +114,7 @@

{% endunless %} {% include layouts/lang-navigation.html %} + {% include layouts/new-to-plotly.html %}

diff --git a/_posts/plotly_js/basic/pie/2020-01-14-inside-text-orientation.html b/_posts/plotly_js/basic/pie/2020-01-14-inside-text-orientation.html index 41c1d8278535..85ec5d096fea 100644 --- a/_posts/plotly_js/basic/pie/2020-01-14-inside-text-orientation.html +++ b/_posts/plotly_js/basic/pie/2020-01-14-inside-text-orientation.html @@ -1,12 +1,12 @@ --- -name: Control text orientation inside Pie slices +name: Control Text Orientation Inside Pie Chart Sectors language: plotly_js suite: pie order: 5 sitemap: false arrangement: horizontal markdown_content: | - The [insidetextorientation](https://plot.ly/javascript/reference/#pie-insidetextorientation) attribute controls the orientation of the texts inside slices. With 'auto' the texts may automatically be rotated to fit with the maximum size inside the slice. The other three options 'horizontal', 'radial', and 'tangential' forces text to be horizontal, radial, and tangential. + The `insidetextorientation` attribute controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector. --- var data = [{ type: "pie", @@ -15,6 +15,7 @@ textinfo: "label+percent", insidetextorientation: "radial" }] + var layout = [{ height: 700, width: 700 diff --git a/_posts/plotly_js/basic/sunburst/2020-01-14-inside-text-orientation.html b/_posts/plotly_js/basic/sunburst/2020-01-14-inside-text-orientation.html index 290b602d5a86..1083eebad1b6 100644 --- a/_posts/plotly_js/basic/sunburst/2020-01-14-inside-text-orientation.html +++ b/_posts/plotly_js/basic/sunburst/2020-01-14-inside-text-orientation.html @@ -1,29 +1,29 @@ --- -name: Control text orientation inside Sunburst slices +name: Control Text Orientation Inside Sunburst Chart Sectors language: plotly_js suite: sunburst order: 6 sitemap: false arrangement: horizontal markdown_content: | - The [insidetextorientation](https://plot.ly/javascript/reference/#sunburst-insidetextorientation) attribute controls the orientation of the texts inside chart sectors. When set to 'auto' the texts may automatically be rotated to fit with the maximum size inside a sector. The other three options 'horizontal', 'radial', and 'tangential' first try to orient text at the 3:00, 6:00, 9:00, and 12:00 hours. If there is no enough room, then the text would be positioned in the middle of the arc. + The `insidetextorientation` attribute controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector. --- Plotly.d3.csv('https://raw.githubusercontent.com/plotly/datasets/master/coffee-flavors.csv', function(err, rows){ function unpack(rows, key) { return rows.map(function(row) {return row[key]}) } -var data = [{ - type: "sunburst", - maxdepth: 2, - ids: unpack(rows, 'ids'), - labels: unpack(rows, 'labels'), - parents: unpack(rows, 'parents'), - textposition: 'inside', - insidetextorientation: 'radial' -}] + var data = [{ + type: "sunburst", + maxdepth: 2, + ids: unpack(rows, 'ids'), + labels: unpack(rows, 'labels'), + parents: unpack(rows, 'parents'), + textposition: 'inside', + insidetextorientation: 'radial' + }] -var layout = {margin: {l: 0, r: 0, b: 0, t:0}} + var layout = {margin: {l: 0, r: 0, b: 0, t:0}} -Plotly.newPlot('myDiv', data, layout) + Plotly.newPlot('myDiv', data, layout) }) \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-locale.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-locale.html index 7526cc29a84b..d0ff05a168ec 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-locale.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-locale.html @@ -1,6 +1,5 @@ --- name: Change the Default Locale -plot_url: https://codepen.io/plotly/embed/rqrgEQ/?height=600&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 7.5 @@ -36,5 +35,4 @@ var config = {locale: 'fr'}; -Plotly.newPlot('myDiv', data, layout, config); - +Plotly.newPlot('myDiv', data, layout, config); \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-display-modebar.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-display-modebar.html deleted file mode 100644 index d3842325089d..000000000000 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-display-modebar.html +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Always Display the Modebar -plot_url: https://codepen.io/plotly/embed/jbMvLq/?height=450&theme-id=15263&default-tab=result -language: plotly_js -suite: configuration -order: 4 -sitemap: false -arrangement: horizontal ---- -var trace1 = { - y:['Marc', 'Henrietta', 'Jean', 'Claude', 'Jeffrey', 'Jonathan', 'Jennifer', 'Zacharias'], - x: [90, 40, 60, 80, 75, 92, 87, 73], - type: 'bar', - orientation: 'h' -}; - -var data = [trace1]; - -var layout = { - title: 'Always Display the Modebar', - showlegend: false -}; - -Plotly.newPlot('myDiv', data, layout, {displayModeBar: true}); diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-displaylogo.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-displaylogo.html index 9b702bc880e4..1c2d9a696e7c 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-displaylogo.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-displaylogo.html @@ -1,6 +1,5 @@ --- name: Hide the Plotly Logo on the Modebar -plot_url: https://codepen.io/plotly/embed/EVgeWb/?height=450&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 8 diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-hide-modebar.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-hide-modebar.html index 0e28e66029f4..45d50391960e 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-hide-modebar.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-hide-modebar.html @@ -1,11 +1,14 @@ --- -name: Hide the Modebar -plot_url: https://codepen.io/plotly/embed/YyGOLg/?height=450&theme-id=15263&default-tab=result +name: Never Display The Modebar language: plotly_js suite: configuration order: 5 sitemap: false arrangement: horizontal +markdown_content: | + When users hover over a figure generated with `plotly.js`, a `modebar` appears in the top-right of the figure. This presents users with several options for interacting with the figure. + + By default, the `modebar` is only visible while the user is hovering over the chart. If you would like the `modebar` to never be visible, then set the `displayModeBar` attribute in the `config` of your figure to `false`. --- var trace1 = { x:['Zebras', 'Lions', 'Pelicans'], diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html index 40547d1eaceb..dced1b265f12 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html @@ -1,21 +1,16 @@ --- -name: Modify the "Edit Chart" Link Text -plot_url: https://codepen.io/plotly/embed/WQGgbe/?height=600&theme-id=15263&default-tab=result +name: Customize The `Edit Chart` Link Text language: plotly_js suite: configuration order: 7 sitemap: false arrangement: horizontal --- -var trace1 = { - z: [[0, 1, 2, 3, 4, 5, 6], [1, 9, 4, 7, 5, 2, 4], [2, 4, 2, 1, 6, 9, 3]], - type: 'heatmap' -}; +var data = [{ + z: [[0, 1, 2, 3, 4, 5, 6], + [1, 9, 4, 7, 5, 2, 4], + [2, 4, 2, 1, 6, 9, 3]], + type: 'heatmap'}] -var data = [trace1]; - -var layout = { - title: 'Change the Link Text' -}; - -Plotly.newPlot('myDiv', data, layout, {linkText: 'Change this text'}); +var layout = {title: 'Customize The Edit Chart Link Text'} +Plotly.newPlot('myDiv', data, layout, {showLink: true, linkText: 'This text is custom!'}) \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-scrollzoom.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-scrollzoom.html index 3a918b0b106c..e05bddbbac9d 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-scrollzoom.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-scrollzoom.html @@ -1,6 +1,5 @@ --- name: Scroll and Zoom -plot_url: https://codepen.io/plotly/embed/QjKZbg/?height=450&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 1 diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html index b2a8905a5509..c54a959727fe 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html @@ -1,6 +1,5 @@ --- -name: Display the "Edit Chart" Link -plot_url: https://codepen.io/plotly/embed/epdjem/?height=600&theme-id=15263&default-tab=result +name: Display the `Edit Chart` Link language: plotly_js suite: configuration order: 6 @@ -18,7 +17,9 @@ }; var data = [trace1]; + var layout = { title: 'Display the Edit Chart Link' }; + Plotly.newPlot('myDiv', data, layout, {showLink: true}); diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-static-plot.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-static-plot.html index fa2fff977f97..9d044266a110 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-static-plot.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-static-plot.html @@ -1,6 +1,5 @@ --- name: Making a Static Chart -plot_url: https://codepen.io/plotly/embed/YyGjda/?height=450&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 3 diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-toImageButtonOptions.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-toImageButtonOptions.html index ff430c1e4820..e4825cd3bd75 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-toImageButtonOptions.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-toImageButtonOptions.html @@ -1,6 +1,5 @@ --- name: Customize Download Plot Options -plot_url: https://codepen.io/plotly/embed/MZjYRB/?height=450&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 3.1 diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html index ed5ec7b1089e..d799d3955a20 100644 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html @@ -1,6 +1,5 @@ --- name: Display Edit in Chart Studio Button -plot_url: https://codepen.io/plotly/embed/aPpzzw/?height=600&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 7.1 diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config_options_index.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config_options_index.html index 209435506358..73958ca0e9f2 100755 --- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config_options_index.html +++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config_options_index.html @@ -1,16 +1,18 @@ --- name: Configuration Options permalink: javascript/configuration-options/ -description: How to configure your Plotly graph in javascript. +description: How to set the configuration options for figures in JavaScript. layout: base language: plotly_js page_type: example_index thumbnail: thumbnail/modebar-icons.png -display_as: reference +display_as: file_settings +order: 1 --- + The plotly.js config argument sets properties like the mode bar buttons and the interactivity in the chart. -It's the last argument in Plotly.newPlot and Plotly.newPlot calls. +It's the last argument in Plotly.newPlot calls.
View the full list of configuration options in the @@ -19,9 +21,8 @@ .

-For Enterprise Users: For Configuring the On-Premise Version, The custom domain should be set by adding the following line in the javascript code: +For Chart Studio Enterprise Users: Store the custom domain of your Chart Studio Enterprise server by adding the following line to your JavaScript code: 
PLOTLYENV = 'https://<domain>.plot.ly';
- {% assign examples = site.posts | where:"language","plotly_js" | where:"suite","configuration" | sort: "order" %} {% include posts/auto_examples.html examples=examples %} \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2017-03-01-edit_mode.html b/_posts/plotly_js/fundamentals/config-options/2017-03-01-edit_mode.html index ac2395e4b15f..b302df1452be 100644 --- a/_posts/plotly_js/fundamentals/config-options/2017-03-01-edit_mode.html +++ b/_posts/plotly_js/fundamentals/config-options/2017-03-01-edit_mode.html @@ -1,11 +1,12 @@ --- -name: Edit Mode -plot_url: https://codepen.io/plotly/embed/VpeMKo/?height=450&theme-id=15263&default-tab=result +name: Editable Mode language: plotly_js suite: configuration order: 2 sitemap: false arrangement: horizontal +markdown_content: | + In editable mode, users can edit the chart title, axis labels and trace names in the legend. --- var trace1 = { x: [0, 1, 2, 3, 4], @@ -22,7 +23,6 @@ }; var data = [trace1, trace2]; -var layout = { - title: 'Click Here
to Edit Chart Title'}; +var layout = {title: 'Click Here
to Edit Chart Title'}; Plotly.newPlot('myDiv', data, layout, {editable: true}); \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2018-02-04-config-opt-modebarButtons.html b/_posts/plotly_js/fundamentals/config-options/2018-02-04-config-opt-modebarButtons.html deleted file mode 100644 index 5640cb93e0e0..000000000000 --- a/_posts/plotly_js/fundamentals/config-options/2018-02-04-config-opt-modebarButtons.html +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Remove Modebar Buttons -plot_url: https://codepen.io/plotly/embed/OQyEaP/?height=450&theme-id=15263&default-tab=result -language: plotly_js -suite: configuration -order: 9 -sitemap: false -arrangement: horizontal ---- - -var trace1 = { - x:['trees', 'flowers', 'hedges'], - y: [90, 130, 40], - type: 'bar' -}; - -var data = [trace1]; -var layout = { - title: 'Remove Modebar Buttons', - showlegend: false}; -Plotly.newPlot('myDiv', data, layout, {modeBarButtonsToRemove: ['toImage']}); diff --git a/_posts/plotly_js/fundamentals/config-options/2018-09-12-config-opt-responsive.html b/_posts/plotly_js/fundamentals/config-options/2018-09-12-config-opt-responsive.html index 395d1115310e..fb995332ed81 100644 --- a/_posts/plotly_js/fundamentals/config-options/2018-09-12-config-opt-responsive.html +++ b/_posts/plotly_js/fundamentals/config-options/2018-09-12-config-opt-responsive.html @@ -1,6 +1,5 @@ --- name: Making a Responsive Chart -plot_url: https://codepen.io/plotly/embed/BOxMXz/?height=550&theme-id=15263&default-tab=result language: plotly_js suite: configuration order: 10 @@ -22,7 +21,7 @@ var data = [ trace1 ]; var layout = { - title: 'Responsive to window's size!', + title: 'Responsive to window size!', font: {size: 18} }; diff --git a/_posts/plotly_js/fundamentals/config-options/2020-01-24-add-button-to-modebar.html b/_posts/plotly_js/fundamentals/config-options/2020-01-24-add-button-to-modebar.html new file mode 100644 index 000000000000..b40d4d9920dd --- /dev/null +++ b/_posts/plotly_js/fundamentals/config-options/2020-01-24-add-button-to-modebar.html @@ -0,0 +1,45 @@ +--- +name: Add Buttons to ModeBar +language: plotly_js +suite: configuration +order: 5.7 +sitemap: false +arrangement: horizontal +markdown_content: | + The following example shows how to add a button to your modebar, either by using one of the [Plotly icons](https://github.com/plotly/plotly.js/blob/master/src/fonts/ploticon.js) or an [arbitrary icon](https://fontawesome.com/icons?d=gallery&m=free) with a custom behaviour. +--- +var icon1 = { + 'width': 500, + 'height': 600, + 'path': 'M224 512c35.32 0 63.97-28.65 63.97-64H160.03c0 35.35 28.65 64 63.97 64zm215.39-149.71c-19.32-20.76-55.47-51.99-55.47-154.29 0-77.7-54.48-139.9-127.94-155.16V32c0-17.67-14.32-32-31.98-32s-31.98 14.33-31.98 32v20.84C118.56 68.1 64.08 130.3 64.08 208c0 102.3-36.15 133.53-55.47 154.29-6 6.45-8.66 14.16-8.61 21.71.11 16.4 12.98 32 32.1 32h383.8c19.12 0 32-15.6 32.1-32 .05-7.55-2.61-15.27-8.61-21.71z' +} + +var colors = ['green', 'red', 'blue'] +var data = [{ + mode: 'lines', + y: [2, 1, 2], + line: {color: colors[0], width: 3, shape: 'spline'} +}] + +var layout = { + title: 'add mode bar button with custom icon', + modebardisplay: false} + +var config = { + modeBarButtonsToAdd: [ + { + name: 'color toggler', + icon: icon1, + click: function(gd) { + var newColor = colors[Math.floor(3 * Math.random())] + Plotly.restyle(gd, 'line.color', newColor) + }}, + { + name: 'button1', + icon: Plotly.Icons.pencil, + direction: 'up', + click: function(gd) {alert('button1') + }}], + modeBarButtonsToRemove: ['pan2d','select2d','lasso2d','resetScale2d','zoomOut2d']} + +Plotly.newPlot('myDiv', data, layout, config) \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/config-options/2020-01-24-display-modebar.html b/_posts/plotly_js/fundamentals/config-options/2020-01-24-display-modebar.html new file mode 100644 index 000000000000..3558dda7816d --- /dev/null +++ b/_posts/plotly_js/fundamentals/config-options/2020-01-24-display-modebar.html @@ -0,0 +1,23 @@ +--- +name: Force The Modebar to Always Be Visible +language: plotly_js +suite: configuration +order: 4 +sitemap: false +arrangement: horizontal +markdown_content: | + When users hover over a figure generated with `plotly.js`, a `modebar` appears in the top-right of the figure. This presents users with several options for interacting with the figure. + + By default, the `modebar` is only visible while the user is hovering over the chart. If you would like the `modebar` to always be visible regardless of whether or not the user is currently hovering over the figure, set the `displayModeBar` attribute in the `config` of your figure to `true`. +--- +var data = [{ + y:['Marc', 'Henrietta', 'Jean', 'Claude', 'Jeffrey', 'Jonathan', 'Jennifer', 'Zacharias'], + x: [90, 40, 60, 80, 75, 92, 87, 73], + type: 'bar', + orientation: 'h'}] + +var layout = { + title: 'Always Display the Modebar', + showlegend: false} + +Plotly.newPlot('myDiv', data, layout, {displayModeBar: true}) diff --git a/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html b/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html new file mode 100644 index 000000000000..c0026066f223 --- /dev/null +++ b/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html @@ -0,0 +1,27 @@ +--- +name: Remove ModeBar Buttons +language: plotly_js +suite: configuration +order: 5.5 +sitemap: false +arrangement: horizontal +markdown_content: | + To delete buttons from the modebar, pass an array of strings containing the names of the buttons you want to remove to the `modeBarButtonsToRemove` attribute in the figure's configuration object. Note that different chart types have different default modebars. The following is a list of all the modebar buttons and the chart types they are associated with: + +--- +var data = [{ + x:['trees', 'flowers', 'hedges'], + y: [90, 130, 40], + type: 'bar'}] + +var layout = { + title: 'Remove Modebar Buttons', + showlegend: false} + +Plotly.newPlot('myDiv', data, layout, {modeBarButtonsToRemove: ['toImage']}) \ No newline at end of file diff --git a/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md b/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md index 8478f1e563e4..76238b2d2406 100644 --- a/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md +++ b/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md @@ -1,19 +1,18 @@ --- -name: Export JavaScript plots as JPG, PNG ,SVG permalink: javascript/static-image-export/ -description: How to export plotly graphs as static images in JavaScript. Plotly supports jpg, png and svg image export. +description: How to export graphs as static images in JavaScript. The Plotly JavaScript graphing library supports `.jpg`, `.png`, and `.svg` as formats for static image export. layout: base name: Static Image Export thumbnail: thumbnail/png-export.png language: plotly_js display_as: chart_type -page_type: example_index +page_type: u-guide display_as: file_settings -order: 1 +order: 26 sitemap: false --- -You can save plotly graphs to static images and view them in your browser. Consider the following example: +You can save graphs created with `plotly.js` to static images and view them in your browser. Consider the following example: var d3 = Plotly.d3; var img_jpg= d3.select('#jpg-export'); diff --git a/_posts/python-v3/chart-studio/get-requests/2015-04-09-get-requests_python_index.html b/_posts/python-v3/chart-studio/get-requests/2015-04-09-get-requests_python_index.html index 352fbd3b9c1d..967fc5bbec7a 100755 --- a/_posts/python-v3/chart-studio/get-requests/2015-04-09-get-requests_python_index.html +++ b/_posts/python-v3/chart-studio/get-requests/2015-04-09-get-requests_python_index.html @@ -1,7 +1,9 @@ --- -name: Get Requests -permalink: python/v3/get-requests/ -description: How to download plotly users's public graphs and data with python. +name: Working With Chart Studio Graphs +permalink: python/v3/working-with-chart-studio-graphs/ +redirect_from: +- python/v3/get-requests/ +description: How to download Chart Studio users' public graphs and data with Python. layout: base thumbnail: thumbnail/get-requests.jpg language: python/v3 diff --git a/_posts/python/chart-studio/2019-07-03-get-requests.html b/_posts/python/chart-studio/2019-07-03-get-requests.html index 55c29c736e42..69b531c3b349 100644 --- a/_posts/python/chart-studio/2019-07-03-get-requests.html +++ b/_posts/python/chart-studio/2019-07-03-get-requests.html @@ -1,11 +1,12 @@ --- -description: How to download plotly users's public graphs and data with python. +description: How to download Chart Studio users' public graphs and data into Python. display_as: chart_studio language: python layout: base -name: Get Requests +name: Working With Chart Studio Graphs order: 8 -permalink: python/get-requests/ +permalink: python/working-with-chart-studio-graphs/ +redirect_from: python/get-requests thumbnail: thumbnail/spectral.jpg v4upgrade: True --- diff --git a/_posts/r/chart-studio/2015-04-09-static-image_r_index.Rmd b/_posts/r/chart-studio/2015-04-09-static-image_r_index.Rmd index 6920a751da92..d4bccfdfa4ed 100644 --- a/_posts/r/chart-studio/2015-04-09-static-image_r_index.Rmd +++ b/_posts/r/chart-studio/2015-04-09-static-image_r_index.Rmd @@ -1,16 +1,15 @@ --- -description: How to export plotly graphs as static images in R. Plotly supports png, - svg, jpg, and pdf image export. +description: How to export R graphs as static images using Chart Studio. display_as: chart_studio language: r layout: base -name: Static Image Export +name: Exporting Graphs As Static Images Using Chart Studio order: 2 output: html_document: keep_md: true page_type: example_index -permalink: r/static-image-export/ +permalink: r/chart-studio-image-export/ sitemap: false thumbnail: thumbnail/png-export.png --- @@ -20,64 +19,42 @@ knitr::opts_chunk$set(message = FALSE, warning=FALSE) Sys.setenv("plotly_username"="RPlotBot") Sys.setenv("plotly_api_key"="q0lz6r5efr") ``` +### Supported File Formats -### New to Plotly? +With the `plotly` R package, you can export graphs you create as static images in the `.png` and/or `.jpg`/`.jpeg` file formats for free using the [Chart Studio web service](https://chart-studio.plot.ly/create/#/). -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! +Currently, exporting graphs you create as static images in the `.eps`, `.svg`, and/or `.pdf` format is a feature that is available only to users of [Chart Studio Enterprise](https://plot.ly/online-chart-maker/). -### Version Check +**Note:** It is important to be aware that R graphs containing WebGL-based traces (i.e. of type `scattergl`, `heatmapgl`, `contourgl`, `scatter3d`, `surface`, `mesh3d`, `scatterpolargl`, `cone`, `streamtube`, `splom`, and/or `parcoords`) will include encapsulated rasters instead of vectors for some parts of the image if they are exported as static images in a vector format like `.eps`, `.svg`, and/or `.pdf`. -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. +### Exporting Chart Studio Charts As Static Images -```{r} -library(plotly) -packageVersion('plotly') -``` - -### Supported Formats - -The common image formats: 'PNG', 'JPG/JPEG' are supported. In addition, formats like 'EPS', 'SVG' and 'PDF' are also available for user with a Personal or Professional subscription. You can get more details on our [pricing page] (https://plot.ly/products/cloud/) - -**Note:** It is important to note that any figures containing WebGL traces (i.e. of type scattergl, heatmapgl, contourgl, scatter3d, surface, mesh3d, scatterpolargl, cone, streamtube, splom, or parcoords) that are exported in a vector format like SVG, EPS or PDF will include encapsulated rasters instead of vectors for some parts of the image. +To export your R graphs as static images using the Chart Studio web service, you can use the built-in `plotly_IMAGE()` function. -To access the image in a particular format, you can either: +#### Create A Chart Studio Account And Get An API Key +To use the `plotly_IMAGE()` function, you will need to have a [Chart Studio account](https://chart-studio.plot.ly/Auth/login/?action=signup#/) and an API key (which can be found [in your Chart Studio account online settings](https://plot.ly/settings/api)). Learn more about [getting started with Chart Studio in R](https://plot.ly/r/getting-started-with-chart-studio). -* use the `orca()` function. [Orca](https://github.com/plotly/orca) is Plotly's command line applications for generating static images. +#### Set Environment Variables In Your R Session -* export the image on plotly's servers using `plotly_IMAGE()`. - -* append the format extension to the plot url. i.e. the JPG version of the plot: https://plot.ly/~chris/1638 is available at : https://plot.ly/~chris/1638.jpg. - -### Export Locally - -`4.7.900` and above includes the `orca()` function (replacing the `export()` function), which exports images locally, but requires the processx package: +Let the R session know about your Chart Studio authorization credentials by setting environment variables using [`Sys.setenv()`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/Sys.setenv). ```{r, eval = FALSE} -if (!require("processx")) install.packages("processx") - -p <- plot_ly(z = ~volcano) %>% add_surface() - -orca(p, "surface-plot.svg") +Sys.setenv("plotly_username" = "YOUR USER NAME") +Sys.setenv("plotly_api_key" = "YOUR API KEY") ``` -### Export Using Your Plotly Account - -Another option is to do image export through your plotly account. +#### Use The Development Version Of The `plotly` R Package -First, you will require the development version of plotly, this can be installed using `devtools::install_github("ropensci/plotly")`. In addition, if you haven't already, let the R package know about your credentials. +You will also need to be using the development version of the `plotly` R package in order to use the `plotly_IMAGE()` function. This can be installed from GitHub using the [`devtools`](https://cran.r-project.org/web/packages/devtools/index.html) R package by running the following command in your R session: - -```{r, eval = FALSE} -Sys.setenv("plotly_username" = "YOUR USER NAME") -Sys.setenv("plotly_api_key" = "YOUR API KEY") +```r +devtools::install_github("ropensci/plotly") ``` -This option will export the image on plotly's servers and write the content to a local file `"output.png"` in your working directory. +#### Export R Graph As Static Image + +The `plotly_IMAGE()` function exports your R plots as static images using the Chart Studio web service. The image will be stored in a file in the working directory of your R session. ```{r} library(plotly) @@ -87,7 +64,12 @@ plotly_IMAGE(p, format = "png", out_file = "output.png") ![](https://images.plot.ly/plotly-documentation/images/output.png) -### Appending File Type to URL +### Alternative Methods Of Exporting Graphs As Static Images In R + +#### Local Image Export + +As an alternative to using the Chart Studio web service to export your R graphs as static images, you can [use the built-in `orca()` function](https://plot.ly/r/static-image-export) to export images locally. + +#### Embed R Charts in RMarkdown Documents -You can also view the static version of any Plotly graph by appending `.png`, -`.pdf`, `.eps`, or `.svg` to the end of the URL. For example, view the static image of at . See [Using Plotly with rmarkdown/knitr](https://plot.ly/r/knitr/) for a way to embed these links in rmarkdown/knitr (Rmd) files. +See [Embedding Graphs in RMarkdown](https://plot.ly/r/embedding-graphs-in-rmarkdown/) to learn more about embedding R charts in RMarkdown (.Rmd) files. diff --git a/_posts/r/chart-studio/2015-04-09-static-image_r_index.md b/_posts/r/chart-studio/2015-04-09-static-image_r_index.md index e2c4c7884c41..3500de963796 100644 --- a/_posts/r/chart-studio/2015-04-09-static-image_r_index.md +++ b/_posts/r/chart-studio/2015-04-09-static-image_r_index.md @@ -1,84 +1,57 @@ --- -description: How to export plotly graphs as static images in R. Plotly supports png, - svg, jpg, and pdf image export. +description: How to export R graphs as static images using Chart Studio. display_as: chart_studio language: r layout: base -name: Static Image Export +name: Exporting Graphs As Static Images Using Chart Studio order: 2 output: html_document: keep_md: true page_type: example_index -permalink: r/static-image-export/ +permalink: r/chart-studio-image-export/ sitemap: false thumbnail: thumbnail/png-export.png --- -### 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! +### Supported File Formats -### Version Check +With the `plotly` R package, you can export graphs you create as static images in the `.png` and/or `.jpg`/`.jpeg` file formats for free using the [Chart Studio web service](https://chart-studio.plot.ly/create/#/). -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. +Currently, exporting graphs you create as static images in the `.eps`, `.svg`, and/or `.pdf` format is a feature that is available only to users of [Chart Studio Enterprise](https://plot.ly/online-chart-maker/). +**Note:** It is important to be aware that R graphs containing WebGL-based traces (i.e. of type `scattergl`, `heatmapgl`, `contourgl`, `scatter3d`, `surface`, `mesh3d`, `scatterpolargl`, `cone`, `streamtube`, `splom`, and/or `parcoords`) will include encapsulated rasters instead of vectors for some parts of the image if they are exported as static images in a vector format like `.eps`, `.svg`, and/or `.pdf`. -```r -library(plotly) -packageVersion('plotly') -``` - -``` -## [1] '4.5.6.9000' -``` +### Exporting Chart Studio Charts As Static Images -### Supported Formats +To export your R graphs as static images using the Chart Studio web service, you can use the built-in `plotly_IMAGE()` function. -The common image formats: 'PNG', 'JPG/JPEG' are supported. In addition, formats like 'EPS', 'SVG' and 'PDF' are also available for user with a Personal or Professional subscription. You can get more details on our [pricing page] (https://plot.ly/products/cloud/) +#### Create A Chart Studio Account And Get An API Key -**Note:** It is important to note that any figures containing WebGL traces (i.e. of type scattergl, heatmapgl, contourgl, scatter3d, surface, mesh3d, scatterpolargl, cone, streamtube, splom, or parcoords) that are exported in a vector format like SVG, EPS or PDF will include encapsulated rasters instead of vectors for some parts of the image. +To use the `plotly_IMAGE()` function, you will need to have a [Chart Studio account](https://chart-studio.plot.ly/Auth/login/?action=signup#/) and an API key (which can be found [in your Chart Studio account online settings](https://plot.ly/settings/api)). Learn more about [getting started with Chart Studio in R](https://plot.ly/r/getting-started-with-chart-studio). -To access the image in a particular format, you can either: +#### Set Environment Variables In Your R Session - -* use the `orca()` function. [Orca](https://github.com/plotly/orca) is Plotly's command line applications for generating static images. - -* export the image on plotly's servers using `plotly_IMAGE()`. - -* append the format extension to the plot url. i.e. the JPG version of the plot: https://plot.ly/~chris/1638 is available at : https://plot.ly/~chris/1638.jpg. - -### Export Locally - -`4.7.900` and above includes the `orca()` function (replacing the `export()` function), which exports images locally, but requires the processx package: +Let the R session know about your Chart Studio authorization credentials by setting environment variables using [`Sys.setenv()`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/Sys.setenv). ```r -if (!require("processx")) install.packages("processx") - -p <- plot_ly(z = ~volcano) %>% add_surface() - -orca(p, "surface-plot.png") +Sys.setenv("plotly_username" = "YOUR USER NAME") +Sys.setenv("plotly_api_key" = "YOUR API KEY") ``` -### Export Using Your Plotly Account - -Another option is to do image export through your plotly account. - -First, you will require the development version of plotly, this can be installed using `devtools::install_github("ropensci/plotly")`. In addition, if you haven't already, let the R package know about your credentials. - +#### Use The Development Version Of The `plotly` R Package +You will also need to be using the development version of the `plotly` R package in order to use the `plotly_IMAGE()` function. This can be installed from GitHub using the [`devtools`](https://cran.r-project.org/web/packages/devtools/index.html) R package by running the following command in your R session: ```r -Sys.setenv("plotly_username" = "YOUR USER NAME") -Sys.setenv("plotly_api_key" = "YOUR API KEY") +devtools::install_github("ropensci/plotly") ``` -This option will export the image on plotly's servers and write the content to a local file `"output.png"` in your working directory. +#### Export R Graph As Static Image + +The `plotly_IMAGE()` function exports your R plots as static images using the Chart Studio web service. The image will be stored in a file in the working directory of your R session. ```r @@ -89,7 +62,12 @@ plotly_IMAGE(p, format = "png", out_file = "output.png") ![](https://images.plot.ly/plotly-documentation/images/output.png) -### Appending File Type to URL +### Alternative Methods Of Exporting Graphs As Static Images In R + +#### Local Image Export + +As an alternative to using the Chart Studio web service to export your R graphs as static images, you can [use the built-in `orca()` function](https://plot.ly/r/static-image-export) to export images locally. + +#### Embed R Charts in RMarkdown Documents -You can also view the static version of any Plotly graph by appending `.png`, -`.pdf`, `.eps`, or `.svg` to the end of the URL. For example, view the static image of at . See [Using Plotly with rmarkdown/knitr](https://plot.ly/r/knitr/) for a way to embed these links in rmarkdown/knitr (Rmd) files. +See [Embedding Graphs in RMarkdown](https://plot.ly/r/embedding-graphs-in-rmarkdown/) to learn more about embedding R charts in RMarkdown (.Rmd) files. diff --git a/_posts/r/chart-studio/2015-07-30-filenames.Rmd b/_posts/r/chart-studio/2015-07-30-filenames.Rmd index b497f24fe418..9dd5db3df54f 100644 --- a/_posts/r/chart-studio/2015-07-30-filenames.Rmd +++ b/_posts/r/chart-studio/2015-07-30-filenames.Rmd @@ -1,10 +1,10 @@ --- -description: R Filenames, folders, and updating Plotly graphs in the plotly cloud. +description: How to update graphs stored in Chart Studio with R. display_as: chart_studio language: r layout: base -name: Updating Plotly Graphs -order: 1 +name: Updating Graphs Stored In Chart Studio +order: 9 output: html_document: keep_md: true @@ -18,44 +18,36 @@ knitr::opts_chunk$set(message = FALSE, warning=FALSE) Sys.setenv("plotly_username"="RPlotBot") Sys.setenv("plotly_api_key"="q0lz6r5efr") ``` -### New to Plotly? +### Save R Plot To Chart Studio -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 Server -To create a plotly figure on a plotly server, use `api_create()`. +Using the `plotly` R package, you can create a Chart Studio figure based on your R chart. Simply pass your chart as a parameter to the `api_create()` function: ```{r} library(plotly) -p <- plot_ly(x = c(1, 2), y = c(1, 2)) +p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length) api_create(p) ``` -#### Overwrite Plot +### How To Overwrite An Existing Plot + +By default, when you call `api_create()`, a new plot is created in your Chart Studio account with its own unique URL. -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. +If you would like to overwrite an existing plot in your Chart Studio account and keep the same URL, then supply a `filename` as an extra parameter to the `api_create()` function. This will keep the same URL for the plot. ```{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 plotly folder. This option is only available for [Pro-Subscriptions](https://plot.ly/products/cloud/) +### Saving Plots In Folders + +If the `filename` parameter contains the character "/", then the `api_create()` function will save that plot in a folder in your Chart Studio account. + +This option is only available for [Chart Studio Enterprise subscribers](https://plot.ly/online-chart-maker/) ```{r} -api_create(p, filename="r-docs-name-of-my-plotly-file") +api_create(p, filename="r-docs/name-of-my-chart-studio-file") ``` -View your Plotly graphs at [https://plot.ly/organize](https://plot.ly/organize). +### Viewing Saved Plots + +View the R graphs you have saved in your Chart Studio account at [https://plot.ly/organize](https://plot.ly/organize). \ No newline at end of file diff --git a/_posts/r/chart-studio/2015-07-30-filenames.md b/_posts/r/chart-studio/2015-07-30-filenames.md index fe309d75e436..077fe4188662 100644 --- a/_posts/r/chart-studio/2015-07-30-filenames.md +++ b/_posts/r/chart-studio/2015-07-30-filenames.md @@ -1,10 +1,10 @@ --- -description: R Filenames, folders, and updating Plotly graphs in the plotly cloud. +description: How to update graphs stored in Chart Studio with R. display_as: chart_studio language: r layout: base -name: Updating Plotly Graphs -order: 1 +name: Updating Graphs Stored In Chart Studio +order: 9 output: html_document: keep_md: true @@ -13,42 +13,25 @@ permalink: r/file-options/ thumbnail: thumbnail/horizontal-bar.jpg --- -### 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! +### Save R Plot To Chart Studio -### Version Check +Using the `plotly` R package, you can create a Chart Studio figure based on your R chart. Simply pass your chart as a parameter to the `api_create()` function: -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') -``` - -``` -## [1] '4.7.1' -``` - -#### Save Plot to Server -To create a plotly figure on a plotly server, use `api_create()`. - - -```r -library(plotly) -p <- plot_ly(x = c(1, 2), y = c(1, 2)) +p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length) api_create(p) ``` - + + +### How To Overwrite An Existing Plot -#### Overwrite Plot +By default, when you call `api_create()`, a new plot is created in your Chart Studio account with its own unique URL. -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. +If you would like to overwrite an existing plot in your Chart Studio account and keep the same URL, then supply a `filename` as an extra parameter to the `api_create()` function. This will keep the same URL for the plot. ```r @@ -57,14 +40,19 @@ api_create(p, filename = "name-of-my-plotly-file") -#### Save your Plot in a Folder -If the filename contains "/", it will automatically create a plotly folder. This option is only available for [Pro-Subscriptions](https://plot.ly/products/cloud/) +### Saving Plots In Folders + +If the `filename` parameter contains the character "/", then the `api_create()` function will save that plot in a folder in your Chart Studio account. + +This option is only available for [Chart Studio Enterprise subscribers](https://plot.ly/online-chart-maker/) ```r -api_create(p, filename="r-docs-name-of-my-plotly-file") +api_create(p, filename="r-docs/name-of-my-chart-studio-file") ``` - + + +### Viewing Saved Plots -View your Plotly graphs at [https://plot.ly/organize](https://plot.ly/organize). +View the R graphs you have saved in your Chart Studio account at [https://plot.ly/organize](https://plot.ly/organize). diff --git a/_posts/r/chart-studio/2015-07-30-get-requests.Rmd b/_posts/r/chart-studio/2015-07-30-get-requests.Rmd index 125700d02e6a..5daeee4181fe 100644 --- a/_posts/r/chart-studio/2015-07-30-get-requests.Rmd +++ b/_posts/r/chart-studio/2015-07-30-get-requests.Rmd @@ -1,15 +1,17 @@ --- -description: How to download plotly users's public graphs and data with R. +description: How to download Chart Studio users' public graphs and data into an R session. display_as: chart_studio language: r layout: base -name: Get Requests +name: Working With Chart Studio Graphs order: 6 output: html_document: keep_md: true -permalink: r/get-requests/ -thumbnail: thumbnail/get-requests.jpg +permalink: r/working-with-chart-studio-graphs/ +redirect_from: +- r/get-requests/ +thumbnail: thumbnail/hover.jpg --- ```{r, echo = FALSE, message=FALSE} @@ -17,60 +19,38 @@ knitr::opts_chunk$set(message = FALSE, warning=FALSE) Sys.setenv("plotly_username"="RPlotBot") Sys.setenv("plotly_api_key"="q0lz6r5efr") ``` -### New to Plotly? +### Download Chart Studio Graphs Into R Sessions -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') -``` - -### Download Plotly Graphs into R - -Download Plotly figures directly into R with `api_download_plot()`. This takes the `plot_id` and the `username` as arguments. +Download Chart Studio figures directly into your R session with the `api_download_plot()` function. This takes the `plot_id` of the Chart Studio plot and the `username` of the plot's creator as arguments. For example, to download [https://plot.ly/~cpsievert/559](https://plot.ly/~cpsievert/559) into R, call: -```{r, results = 'hide'} +```{r} library(plotly) fig <- api_download_plot("559", "cpsievert") +fig ``` -```{r, echo=FALSE} -api_create(fig, filename="getRequests-download") -``` +### Update The Layout on A Downloaded Graph -### Edit Downloaded Graph -Once the figure is downloaded, you can edit it like any plotly object. This will create a new figure unless you specify the same filename as the figure that you downloaded. +Once the figure is downloaded from Chart Studio into your R session, you can update its layout just like you would any other figure you create with the `plotly` R package. -```{r, results = 'hide'} -p <- layout(fig, title = paste("Modified on ", Sys.time())) -``` +**Note:** If you were to re-upload this figure to Chart Studio, a new figure would be created unless you specify the same `filename` as the figure that you downloaded. In that case, the existing figure will be overwritten. -```{r, echo=FALSE} -api_create(p, filename="getRequests-modify") +```{r} +p <- layout(fig, title = paste("Modified on ", Sys.time())) +p ``` -### Adding a trace to a subplot figure +### Adding a Trace to a Subplot Figure -```{r, results = 'hide'} +```{r} fig <- api_download_plot("6343", "chelsea_lyn") p <- add_lines(fig, x = c(1, 2), y = c(1, 2), xaxis = "x2", yaxis = "y2") -``` - -```{r, echo=FALSE} -api_create(p, filename="getRequests-subplot") +p ``` ### Reference -See `help("api")` +See the documentation for [getting started with Chart Studio in R](https://plot.ly/r/getting-started-with-chart-studio). \ No newline at end of file diff --git a/_posts/r/chart-studio/2015-07-30-get-requests.md b/_posts/r/chart-studio/2015-07-30-get-requests.md index 6368505a467a..5931d4f247c6 100644 --- a/_posts/r/chart-studio/2015-07-30-get-requests.md +++ b/_posts/r/chart-studio/2015-07-30-get-requests.md @@ -1,41 +1,23 @@ --- -description: How to download plotly users's public graphs and data with R. +description: How to download Chart Studio users' public graphs and data into an R session. display_as: chart_studio language: r layout: base -name: Get Requests +name: Working With Chart Studio Graphs order: 6 output: html_document: keep_md: true -permalink: r/get-requests/ -thumbnail: thumbnail/tick-formatting.gif +permalink: r/working-with-chart-studio-graphs/ +redirect_from: +- r/get-requests/ +thumbnail: thumbnail/hover.jpg --- -### 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! +### Download Chart Studio Graphs Into R Sessions -### 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') -``` - -``` -## [1] '4.7.0.9000' -``` - -### Download Plotly Graphs into R - -Download Plotly figures directly into R with `api_download_plot()`. This takes the `plot_id` and the `username` as arguments. +Download Chart Studio figures directly into your R session with the `api_download_plot()` function. This takes the `plot_id` of the Chart Studio plot and the `username` of the plot's creator as arguments. For example, to download [https://plot.ly/~cpsievert/559](https://plot.ly/~cpsievert/559) into R, call: @@ -43,31 +25,40 @@ For example, to download [https://plot.ly/~cpsievert/559](https://plot.ly/~cpsie ```r library(plotly) fig <- api_download_plot("559", "cpsievert") +fig ``` - +
+ + +### Update The Layout on A Downloaded Graph + +Once the figure is downloaded from Chart Studio into your R session, you can update its layout just like you would any other figure you create with the `plotly` R package. -### Edit Downloaded Graph -Once the figure is downloaded, you can edit it like any plotly object. This will create a new figure unless you specify the same filename as the figure that you downloaded. +**Note:** If you were to re-upload this figure to Chart Studio, a new figure would be created unless you specify the same `filename` as the figure that you downloaded. In that case, the existing figure will be overwritten. ```r p <- layout(fig, title = paste("Modified on ", Sys.time())) +p ``` - +
+ -### Adding a trace to a subplot figure +### Adding a Trace to a Subplot Figure ```r fig <- api_download_plot("6343", "chelsea_lyn") p <- add_lines(fig, x = c(1, 2), y = c(1, 2), xaxis = "x2", yaxis = "y2") +p ``` - +
+ ### Reference -See `help("api")` +See the documentation for [getting started with Chart Studio in R](https://plot.ly/r/getting-started-with-chart-studio). diff --git a/_posts/r/chart-studio/2015-07-30-privacy.Rmd b/_posts/r/chart-studio/2015-07-30-privacy.Rmd index 087417bf9888..e2a4a3a1baad 100644 --- a/_posts/r/chart-studio/2015-07-30-privacy.Rmd +++ b/_posts/r/chart-studio/2015-07-30-privacy.Rmd @@ -1,10 +1,10 @@ --- -description: How to set the privacy settings of plotly graphs in R. +description: How to set the privacy settings of Chart Studio graphs in R. display_as: chart_studio language: r layout: base -name: Public vs Private Graphs -order: 7 +name: Privacy Settings For Chart Studio Graphs +order: 8 output: html_document: keep_md: true @@ -17,65 +17,43 @@ 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! +#### Default Privacy +The `plotly` R package renders plots entirely **locally** by default. -### 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') -``` +However, you can also choose to publish plots on the web using Chart Studio via the `api_create()` function. -#### Default Privacy -Plotly for R renders entirely locally by default, but you can also publish these graphs to the web via the `api_create()` function. By default, `api_create()` creates public graphs (which are free to create), but with a [plotly subscription](https://plot.ly/products/cloud/) you can easily make them private via the `sharing` argument. +By default, the `api_create()` function creates public graphs. With a [Chart Studio Enterprise subscription](https://plot.ly/online-chart-maker/), you can easily make graphs private by using the `sharing` argument of the `api_create()` function. ### Public Graph + Please note, this is the default privacy option. -```{r, results = 'hide'} +```{r} library(plotly) p <- plot_ly(x = c(0, 2, 4), y = c(0, 4, 2), type = 'scatter', mode = 'markers+lines') chart_link = api_create(p, filename = "public-graph") chart_link ``` -```{r, echo=FALSE} -chart_link -``` - Below is the URL of this public plot. Anyone can view public plots even if they are not logged into Plotly.
Try it out: [https://plot.ly/~RPlotBot/4545](https://plot.ly/~RPlotBot/4545) ### Private Graph -```{r, results = 'hide'} +```{r} library(plotly) p <- plot_ly(x = c(0, 2, 4), y = c(0, 4, 2), type = 'scatter', mode = 'markers+lines') chart_link = api_create(p, filename = "private-graph", sharing = "private") chart_link ``` -```{r, echo=FALSE} -chart_link -``` - Below is the URL of the private plot above. Only the owner can view the private plot. You won't be able to view this plot.
Try it out: [https://plot.ly/~RPlotBot/4549/](https://plot.ly/~RPlotBot/4549/) ### Secret Graph -```{r, results = 'hide'} +```{r} library(plotly) p <- plot_ly(x = c(0, 2, 4), y = c(0, 4, 2), type = 'scatter', mode = 'markers+lines') -chart_link = api_create(p, filename = "secret-graph", sharing = "secret") -chart_link -``` - -```{r, echo=FALSE} -chart_link +secret_graph = api_create(p, filename = "secret-graph-file", sharing = "secret") +secret_graph ``` Below is the URL of this secret plot. Anyone with the secret link can view this chart. However, it will not appear in the Plotly feed, your profile, or search engines.
Try it out: -[https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj](https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj) +[https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj](https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj) \ No newline at end of file diff --git a/_posts/r/chart-studio/2015-07-30-privacy.md b/_posts/r/chart-studio/2015-07-30-privacy.md index 44311c67c0d1..49b276dc325f 100644 --- a/_posts/r/chart-studio/2015-07-30-privacy.md +++ b/_posts/r/chart-studio/2015-07-30-privacy.md @@ -1,10 +1,10 @@ --- -description: How to set the privacy settings of plotly graphs in R. +description: How to set the privacy settings of Chart Studio graphs in R. display_as: chart_studio language: r layout: base -name: Public vs Private Graphs -order: 7 +name: Privacy Settings For Chart Studio Graphs +order: 8 output: html_document: keep_md: true @@ -12,30 +12,16 @@ permalink: r/privacy/ thumbnail: thumbnail/privacy.jpg --- -### 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! +#### Default Privacy +The `plotly` R package renders plots entirely **locally** by default. -### 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. +However, you can also choose to publish plots on the web using Chart Studio via the `api_create()` function. -```r -library(plotly) -packageVersion('plotly') -``` - -``` -## [1] '4.7.0' -``` - -#### Default Privacy -Plotly for R renders entirely locally by default, but you can also publish these graphs to the web via the `api_create()` function. By default, `api_create()` creates public graphs (which are free to create), but with a [plotly subscription](https://plot.ly/products/cloud/) you can easily make them private via the `sharing` argument. +By default, the `api_create()` function creates public graphs. With a [Chart Studio Enterprise subscription](https://plot.ly/online-chart-maker/), you can easily make graphs private by using the `sharing` argument of the `api_create()` function. ### Public Graph + Please note, this is the default privacy option. @@ -68,11 +54,11 @@ Below is the URL of the private plot above. Only the owner can view the private ```r library(plotly) p <- plot_ly(x = c(0, 2, 4), y = c(0, 4, 2), type = 'scatter', mode = 'markers+lines') -chart_link = api_create(p, filename = "secret-graph", sharing = "secret") -chart_link +secret_graph = api_create(p, filename = "secret-graph-file", sharing = "secret") +secret_graph ``` - + Below is the URL of this secret plot. Anyone with the secret link can view this chart. However, it will not appear in the Plotly feed, your profile, or search engines.
Try it out: [https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj](https://plot.ly/~RPlotBot/4553/?share_key=62AMQ8YBpZebu6Y5OYsukj) diff --git a/_posts/r/chart-studio/2015-08-10-knitr.Rmd b/_posts/r/chart-studio/2015-08-10-knitr.Rmd index a4c10f0a50ff..b6b57b181ad9 100644 --- a/_posts/r/chart-studio/2015-08-10-knitr.Rmd +++ b/_posts/r/chart-studio/2015-08-10-knitr.Rmd @@ -1,19 +1,18 @@ --- -description: How to embed Plotly graphs in Rmd files. +description: How to embed R graphs in RMarkdown files. display_as: chart_studio language: r layout: base -name: Embedding Graphs with Knitr +name: Embedding Graphs in RMarkdown Files order: 3 output: html_document: - highlight: null keep_md: true - theme: null page_type: example_index -permalink: r/knitr/ +permalink: r/embedding-graphs-in-rmarkdown/ redirect_from: - r/embedding-plotly-graphs-in-HTML +- r/knitr/ thumbnail: thumbnail/ipythonnb.jpg --- @@ -22,52 +21,37 @@ knitr::opts_chunk$set(message = FALSE) Sys.setenv("plotly_username"="RPlotBot") Sys.setenv("plotly_api_key"="q0lz6r5efr") ``` -### New to Plotly? +### Embedding R Graphs in RMarkdown files -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! +If you are creating R charts in an [RMarkdown](http://rmarkdown.rstudio.com/) environment with HTML output (such as RStudio), simply printing a graph you created using the `plotly` R package in a code chunk will result in an interactive HTML graph in the viewer. -### Version Check +When using RMarkdown with non-HTML output, printing a graph you created using the `plotly` R package will result in a `.png` screenshot of the graph being generated. -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') -``` - -### Embedding plotly graphs in Rmd files - -If you are using [rmarkdown](http://rmarkdown.rstudio.com/) with HTML output, printing a `plotly` object in a code chunk will result in an interactive HTML graph. When using rmarkdown with non-HTML output, printing a `plotly` object will result in a png screenshot of the graph. - -```{r, results = "hide"} -library(plotly) p <- plot_ly(economics, x = ~date, y = ~unemploy / pop) +p ``` -```{r, echo=FALSE} -api_create(p, filename='r-docs/knitr-example') -``` +Sometimes, you may want to print a _list_ of graphs in an RMarkdown document. -Sometimes, you may want to print a _list_ of plotly objects. If, for some reason, you don't want to use the [`subplot()` function](https://plot.ly/r/subplots/), you can print a list of htmlwidgets in a single code chunk using the `tagList()` function from the **htmltools** package: +If, for some reason, you don't want to use the [`subplot()` function](https://plot.ly/r/subplots/), you can render a list of `htmlwidgets` in a single code chunk using the `tagList()` function from the [`htmltools`](https://cran.r-project.org/web/packages/htmltools/index.html) package: -```{r, results = "hide"} +```{r} htmltools::tagList(list(p, p)) ``` -Another way to print multiple objects is by using a `lapply`: +Another way to print multiple graphs in an RMarkdown document with the `plotly` R package is by using the [`lapply`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/lapply) function: -```{r, results = "hide"} +```{r} library(plotly) htmltools::tagList(lapply(1:3, function(x) { plot_ly(x = rnorm(10)) })) ``` -Alternatively, you can use for loops: +Alternatively, you can use a `for` loop instead of `lapply`: -```{r, results = "hide"} +```{r} library(plotly) l <- htmltools::tagList() @@ -77,16 +61,20 @@ for (i in 1:3) { l ``` -You can also host your figures on a plotly server via `api_create()` which returns a figure object. When a figure object is printed in an rmarkdown/knitr document, it embeds the figure as an iframe, displaying the plot as it appears on your plotly account. +### Embedding Chart Studio Graphs in RMarkdown Files + +When you publish your plots to Chart Studio via the `api_create()` function, a figure object is returned to your R session. + +When a Chart Studio figure object is rendered in an RMarkdown document, it is embedded as an `iframe`, displaying the plot as it appears on your Chart Studio account. -```{r, results='hide'} +```{r, echo="FALSE", results='hide'} f <- api_create(p) class(f) f ``` -You can control the height/width of that iframe through the `height`/`width` [knitr chunk options](http://yihui.name/knitr/options/), but the figure object also contains the relevant url so you complete control over embedding your figure. The post has more details on how to [embed plotly graphs with HTML iframes](http://help.plot.ly/embed-graphs-in-websites/), but could also use plotly's built-in image export by simply adding a `.png` (or similar) extension. +You can control the height and width of that `iframe` through the `height`/`width` [knitr chunk options](http://yihui.name/knitr/options/), but the figure object also contains the relevant URL so you have complete control over embedding your figure. -```{r} -htmltools::tags$img(src = paste0(f[["url"]], ".png")) -``` +This [post](http://help.plot.ly/embed-graphs-in-websites/) has more details on how to embed Chart Studio graphs within HTML `iframes`, but you could also use Chart Studio's built-in image export by simply adding a `.png` or `.jpeg` file extension to the end of the figure's URL. + +For example, view the static image of at . \ No newline at end of file diff --git a/_posts/r/chart-studio/2015-08-10-knitr.md b/_posts/r/chart-studio/2015-08-10-knitr.md index 6980f349e8c0..8b4ad23ab73d 100644 --- a/_posts/r/chart-studio/2015-08-10-knitr.md +++ b/_posts/r/chart-studio/2015-08-10-knitr.md @@ -1,63 +1,53 @@ --- -description: How to embed Plotly graphs in Rmd files. +description: How to embed R graphs in RMarkdown files. display_as: chart_studio language: r layout: base -name: Embedding Graphs with Knitr +name: Embedding Graphs in RMarkdown Files order: 3 output: html_document: - highlight: null keep_md: true - theme: null page_type: example_index -permalink: r/knitr/ +permalink: r/embedding-graphs-in-rmarkdown/ redirect_from: - r/embedding-plotly-graphs-in-HTML +- r/knitr/ thumbnail: thumbnail/ipythonnb.jpg --- -### 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! +### Embedding R Graphs in RMarkdown files -### Version Check +If you are creating R charts in an [RMarkdown](http://rmarkdown.rstudio.com/) environment with HTML output (such as RStudio), simply printing a graph you created using the `plotly` R package in a code chunk will result in an interactive HTML graph in the viewer. -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') -``` - -``` -## [1] '4.5.6.9000' -``` - -### Embedding plotly graphs in Rmd files - -If you are using [rmarkdown](http://rmarkdown.rstudio.com/) with HTML output, printing a `plotly` object in a code chunk will result in an interactive HTML graph. When using rmarkdown with non-HTML output, printing a `plotly` object will result in a png screenshot of the graph. +When using RMarkdown with non-HTML output, printing a graph you created using the `plotly` R package will result in a `.png` screenshot of the graph being generated. ```r library(plotly) p <- plot_ly(economics, x = ~date, y = ~unemploy / pop) +p ``` - +
+ -Sometimes, you may want to print a _list_ of plotly objects. If, for some reason, you don't want to use the [`subplot()` function](https://plot.ly/r/subplots/), you can print a list of htmlwidgets in a single code chunk using the `tagList()` function from the **htmltools** package: +Sometimes, you may want to print a _list_ of graphs in an RMarkdown document. + +If, for some reason, you don't want to use the [`subplot()` function](https://plot.ly/r/subplots/), you can render a list of `htmlwidgets` in a single code chunk using the `tagList()` function from the [`htmltools`](https://cran.r-project.org/web/packages/htmltools/index.html) package: ```r htmltools::tagList(list(p, p)) ``` -Another way to print multiple objects is by using a `lapply`: +
+ +
+ + +Another way to print multiple graphs in an RMarkdown document with the `plotly` R package is by using the [`lapply`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/lapply) function: ```r @@ -66,7 +56,14 @@ library(plotly) htmltools::tagList(lapply(1:3, function(x) { plot_ly(x = rnorm(10)) })) ``` -Alternatively, you can use for loops: +
+ +
+ +
+ + +Alternatively, you can use a `for` loop instead of `lapply`: ```r @@ -79,7 +76,18 @@ for (i in 1:3) { l ``` -You can also host your figures on a plotly server via `api_create()` which returns a figure object. When a figure object is printed in an rmarkdown/knitr document, it embeds the figure as an iframe, displaying the plot as it appears on your plotly account. +
+ +
+ +
+ + +### Embedding Chart Studio Graphs in RMarkdown Files + +When you publish your plots to Chart Studio via the `api_create()` function, a figure object is returned to your R session. + +When a Chart Studio figure object is rendered in an RMarkdown document, it is embedded as an `iframe`, displaying the plot as it appears on your Chart Studio account. ```r @@ -88,11 +96,8 @@ class(f) f ``` -You can control the height/width of that iframe through the `height`/`width` [knitr chunk options](http://yihui.name/knitr/options/), but the figure object also contains the relevant url so you complete control over embedding your figure. The post has more details on how to [embed plotly graphs with HTML iframes](http://help.plot.ly/embed-graphs-in-websites/), but could also use plotly's built-in image export by simply adding a `.png` (or similar) extension. - +You can control the height and width of that `iframe` through the `height`/`width` [knitr chunk options](http://yihui.name/knitr/options/), but the figure object also contains the relevant URL so you have complete control over embedding your figure. -```r -htmltools::tags$img(src = paste0(f[["url"]], ".png")) -``` +This [post](http://help.plot.ly/embed-graphs-in-websites/) has more details on how to embed Chart Studio graphs within HTML `iframes`, but you could also use Chart Studio's built-in image export by simply adding a `.png` or `.jpeg` file extension to the end of the figure's URL. - +For example, view the static image of at . diff --git a/_posts/r/chart-studio/2015-08-10-plotly-offline.html b/_posts/r/chart-studio/2015-08-10-plotly-offline.html index e7d44141fbb5..a08b0b4d27b3 100644 --- a/_posts/r/chart-studio/2015-08-10-plotly-offline.html +++ b/_posts/r/chart-studio/2015-08-10-plotly-offline.html @@ -1,60 +1,5 @@ --- permalink: r/offline/ -description: Plotly offline using the Plotly R client, Shiny and RStudio -name: Using Plotly Offline -thumbnail: /images/static-image -layout: base -page_type: u-guide -language: r ---- -{% raw %} -
-
-
-
-
- - -
- -
    -
  • Plotly R figures appear interactively within RStudio's graphics viewer without any calls to Plotly's server by default. This means that all plots generated in RStudio are offline. You will have to make a api_create call in order to upload your plot onto the Chart Studio Cloud.
    • -
- -
    -
  • Plotly graphics in RStudio sit on top of the HTML widgets framework and use the open source javascript graphing library plotly.js.
    • -
- -
-
-

Getting the HTML for a Plotly Graph

-

You could treat the viewer in RStudio as an embedded web browser. Thus it's possible to view the source of that page. What you have to do is - click the export button in the viewer, and choose Save as Web Page. - You will then be prompted to save the web page. Then you will be able to view the source code when viewing the plot.

- -
-

- An alternative method in which to get the html for your plot is to call the following command: -
htmlwidgets::saveWidget(as.widget(p), "graph.html"), where p will be your plot figure. - Note that you could name the html file to anything you choose. -

-
-
-

Working with Shiny

-

With Shiny and Plotly you can now make data visualization interactive. What Shiny allows you to do is affect the state of your plots - via widgets provided by the Shiny package or even custom widgets you write in HTML yourself. What this means is that you can interact - with both the styling of the plots, as well as the data that's being plotted. Thus you can do things like filter date on the fly and have - your plot reflect these changes. To get started, visit: https://plot.ly/r/shiny-tutorial/, and for a collection of examples, - checkout: https://plot.ly/r/shiny-gallery

- -
-
-
-
-
- -{% endraw %} +redirect_to: r/getting-started +sitemap: false +--- \ No newline at end of file diff --git a/_posts/r/chart-studio/2016-02-20-jupyter-notebook-r.html b/_posts/r/chart-studio/2016-02-20-jupyter-notebook-r.html index 1619b2efc1bd..09e84ca348aa 100644 --- a/_posts/r/chart-studio/2016-02-20-jupyter-notebook-r.html +++ b/_posts/r/chart-studio/2016-02-20-jupyter-notebook-r.html @@ -1,9 +1,9 @@ --- -description: How to embed Plotly charts in Jupyter notebooks using R +description: How to embed R graphs in Jupyter notebeooks. display_as: chart_studio language: r layout: base -name: Plotly Charts in Jupyter notebooks using R +name: Embed Graphs In Jupyter Notebooks order: 4 page_type: u-guide permalink: r/using-r-in-jupyter-notebooks/ @@ -11,12 +11,12 @@ thumbnail: thumbnail/png-export.png --- -

Plotly charts in Jupyter notebooks using R

+

Embedding R Graphs in Jupyter Notebooks

-

This tutorial should help you get up and running with embedding Plotly charts inside a Jupyter notebook using R

+

This tutorial should help you get up and running with embedding R charts inside a Jupyter notebook.

-

Install python


-

Head on over to https://www.python.org/downloads/, download and install python.

+

Install Python


+

Head on over to https://www.python.org/downloads/ and install Python.

Install Jupyter

Simply run the following command in your console:

@@ -25,7 +25,7 @@

Install Jupyter

Use pip3 for python 3.x. See here for more details.

Install IRKernel

-

Next we'll install a R Kernel so that we can use R commands inside a Jupyter notebook. This is similar to installing a R package. Run this in R.


+

Next we'll install a R Kernel so that we can use R commands inside a Jupyter notebook. This is similar to installing a R package. Run the following code in your R session:


install.packages(c('repr', 'IRdisplay', 'pbdZMQ', 'devtools'))
 devtools::install_github('IRkernel/IRkernel')
 IRkernel::installspec()
@@ -33,10 +33,10 @@ 
Install IRKernel

 
See here for details.

 

 
Install Pandoc

-
Pandoc is required to successfully render a Plotly chart in a Jupyter notebook. You could either:


+
Pandoc is required to successfully render an R chart in a Jupyter notebook. You could either:


 
    
-
  • Download and install Pandoc from here
    • 
-
  • Or use the *.exe files in \bin\pandoc from your R-Studio installation folder
    • 
+
  • Download and install Pandoc from here.
    • 
+
  • Or use the *.exe files in \bin\pandoc from your R-Studio installation folder.
    • 
 

 
Make sure that both pandoc.exe and pandoc-citeproc are available in your local python installation folder (or Jupyter environment if you have setup a separate environment).

 

@@ -60,7 +60,7 @@ 
Create a notebook

 

 
 
Examples: 

-
Here are some examples on how to use plotly inside of a Jupyter notebook.

+
Here are some examples on how to use Plotly's R graphing library inside of a Jupyter notebook.

 

 

 

diff --git a/_posts/r/chart-studio/2017-07-17-configuration-options.Rmd b/_posts/r/chart-studio/2017-07-17-configuration-options.Rmd
index 3d6d9bd66f1c..3fe781c677f3 100644
--- a/_posts/r/chart-studio/2017-07-17-configuration-options.Rmd
+++ b/_posts/r/chart-studio/2017-07-17-configuration-options.Rmd
@@ -1,11 +1,11 @@
 ---
-name: Configuration Options
+name: Configuration Options For Embedded Chart Studio Graphs 
 permalink: r/configuration-options/
-description: How to set configuration options of plotly graphs in python. Examples of both online and offline configurations.
+description: How to set configuration options of embedded Chart Studio graphs in R. Examples of both online and offline configurations.
 layout: base
 language: r
 thumbnail: thumbnail/modebar-icons.png
-display_as: fundamentals
+display_as: chart_studio
 order: 7
 output:
   html_document:
@@ -14,28 +14,14 @@ output:
 
 ```{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
+#### Online Configuration Options 
 
-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')
-```
+Configuration options for graphs created with the `plotly` R package are overridden when those graphs are published to Chart Studio using the `api_create()` function. 
 
-#### Online Configuration Options 
+To set configutation options for charts published to Chart STudio, you can edit the plot's embed url. 
 
-Config options set via our API libraries are overridden on graphs hosted on plot.ly (i.e. when working online). To set configutation options online, you can edit the plot's embed url. Visit our embed tutorial: [click here](http://help.plot.ly/embed-graphs-in-websites/#step-8-customize-the-iframe) for more information on customizing the embed url to remove the "Edit Chart" link, hide the modebar, or autosize the plot.
+Visit our [embed tutorial](http://help.plot.ly/embed-graphs-in-websites/#step-8-customize-the-iframe) for more information on customizing the embed URL to remove the "Edit Chart" link, hide the modebar, or autosize the plot.
 
 #### Offline Configuration Options 
 
@@ -47,18 +33,10 @@ p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length)
 htmlwidgets::saveWidget(config(p, showLink = T), "graph.html")
 ```
 
-Remove the 'collaborate mode bar button':
-```{r, results = 'hide'}
-htmlwidgets::saveWidget(config(p, collaborate = FALSE), "graph.html")
-```
-
 Remove the 'mode bar':
 ```{r, results = 'hide'}
 htmlwidgets::saveWidget(config(p, displayModeBar = FALSE), "graph.html")
 ```
 
 #### Reference
-Arguments are documented [here](https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js).
-```{r, results = 'hide'}
-?config
-```
\ No newline at end of file
+Arguments are documented [here](https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js).
\ No newline at end of file
diff --git a/_posts/r/chart-studio/2017-07-17-configuration-options.md b/_posts/r/chart-studio/2017-07-17-configuration-options.md
index 85d20bfe60fc..814af85b6217 100644
--- a/_posts/r/chart-studio/2017-07-17-configuration-options.md
+++ b/_posts/r/chart-studio/2017-07-17-configuration-options.md
@@ -1,11 +1,11 @@
 ---
-name: Configuration Options
+name: Configuration Options For Embedded Chart Studio Graphs 
 permalink: r/configuration-options/
-description: How to set configuration options of plotly graphs in python. Examples of both online and offline configurations.
+description: How to set configuration options of embedded Chart Studio graphs in R. Examples of both online and offline configurations.
 layout: base
 language: r
 thumbnail: thumbnail/modebar-icons.png
-display_as: fundamentals
+display_as: chart_studio
 order: 7
 output:
   html_document:
@@ -13,30 +13,13 @@ output:
 ---
 
 
-### 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')
-```
+#### Online Configuration Options 
 
-```
-## [1] '4.7.0.9000'
-```
+Configuration options for graphs created with the `plotly` R package are overridden when those graphs are published to Chart Studio using the `api_create()` function. 
 
-#### Online Configuration Options 
+To set configutation options for charts published to Chart STudio, you can edit the plot's embed url. 
 
-Config options set via our API libraries are overridden on graphs hosted on plot.ly (i.e. when working online). To set configutation options online, you can edit the plot's embed url. Visit our embed tutorial: [click here](http://help.plot.ly/embed-graphs-in-websites/#step-8-customize-the-iframe) for more information on customizing the embed url to remove the "Edit Chart" link, hide the modebar, or autosize the plot.
+Visit our [embed tutorial](http://help.plot.ly/embed-graphs-in-websites/#step-8-customize-the-iframe) for more information on customizing the embed URL to remove the "Edit Chart" link, hide the modebar, or autosize the plot.
 
 #### Offline Configuration Options 
 
@@ -49,12 +32,6 @@ p <- plot_ly(data = iris, x = ~Sepal.Length, y = ~Petal.Length)
 htmlwidgets::saveWidget(config(p, showLink = T), "graph.html")
 ```
 
-Remove the 'collaborate mode bar button':
-
-```r
-htmlwidgets::saveWidget(config(p, collaborate = FALSE), "graph.html")
-```
-
 Remove the 'mode bar':
 
 ```r
@@ -63,7 +40,3 @@ htmlwidgets::saveWidget(config(p, displayModeBar = FALSE), "graph.html")
 
 #### Reference
 Arguments are documented [here](https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js).
-
-```r
-?config
-```
diff --git a/_posts/r/chart-studio/2019-12-18-chart-studio-index.html b/_posts/r/chart-studio/2019-12-18-chart-studio-index.html
index d2ad7c64f52a..78ab09ad8902 100644
--- a/_posts/r/chart-studio/2019-12-18-chart-studio-index.html
+++ b/_posts/r/chart-studio/2019-12-18-chart-studio-index.html
@@ -7,7 +7,7 @@
 display_as: chart_studio
 thumbnail: thumbnail/mixed.jpg
 page_type: example_index
-order: 20
+order: 5
 ---
 
 
diff --git a/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.Rmd b/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.Rmd
new file mode 100644
index 000000000000..7f66d5a689f0
--- /dev/null
+++ b/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.Rmd
@@ -0,0 +1,131 @@
+---
+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: u-guide
+display_as: chart_studio
+layout: base
+language: r
+thumbnail: thumbnail/bubble.jpg
+order: 1
+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, by default, 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 [Chart Studio](https://plot.ly/online-chart-maker). In order to do so, follow these steps:
+
+1 - [Create a free Chart Studio account](https://plot.ly/api_signup):

+A Chart Studio account is required to publish R charts to the web using Chart Studio. It's free to get started, and you control the privacy of your charts.
+
+2 - Store your Chart Studio authentication credentials as environment variables in your R session

+Your Chart Studio authentication credentials consist of your Chart Studio username and your Chart Studio API key, which can be found [in your online settings](https://plot.ly/settings/api). 
+
+Use the [`Sys.setenv()`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/Sys.setenv) function to set these credentials as environment variables in your R session.
+
+```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 if you want them to be run every time you start a new R session.
+
+3 - Use the `api_create()` function to publish R charts to Chart Studio:
+
+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 behavior:
+
+When following the instructions above, executing `api_create(p)` will auto open the created Chart Studio 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
+
+### Where To Find Your API Key
+
+Your API key for your free Chart Studio account will be different than the API key for your [Chart Studio Enterprise](https://plot.ly/product/enterprise/) account. 
+
+Visit  to find your Chart Studio Enterprise account API key. 
+
+Remember to replace "your-company.com" with the URL of your company's Chart Studio Enterprise server.
+
+### Set the `plotly_domain` environment variable
+
+The URL that the `plotly` package uses to communicate with Chart Studio will be different if your company has a Chart Studio Enterprise server. In order to make your R session aware of the new URL, set the `plotly_domain` environment variable equal to the URL of your Chart Studio Enterprise server using the `Sys.setenv()` function. 
+
+Save the following command in your [.Rprofile](http://www.statmethods.net/interface/customizing.html) so that it runs every time you start a new R session:
+
+```r
+Sys.setenv("plotly_domain"="https://plotly.your-company.com")
+```
+
+Remember to replace "your-company" with the URL of your company's Chart Studio Enterprise server.
+
+## 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. 
+
+### Appending Static Image File Types to Chart Studio Plot URLs
+
+You can also view the static image version of any public Chart Studio graph by appending `.png` or `.jpeg` to the end of the URL for the graph. 
+
+For example, view the static image of  at . 
+
+[Chart Studio Enterprise](https://plot.ly/online_chart_maker) users can also use this method to get static images in the `.pdf`, `.svg`, and `.eps` file formats. 
+
+## Private Charts In Chart Studio
+
+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/)
diff --git a/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.md b/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.md
new file mode 100644
index 000000000000..8ebe6c2d649a
--- /dev/null
+++ b/_posts/r/chart-studio/2020-01-17-getting-started-with-chart-studio.md
@@ -0,0 +1,129 @@
+---
+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: u-guide
+display_as: chart_studio
+layout: base
+language: r
+thumbnail: thumbnail/bubble.jpg
+order: 1
+output:
+  html_document:
+    keep_md: true
+---
+
+
+
+# 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, by default, 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 [Chart Studio](https://plot.ly/online-chart-maker). In order to do so, follow these steps:
+
+1 - [Create a free Chart Studio account](https://plot.ly/api_signup):

+A Chart Studio account is required to publish R charts to the web using Chart Studio. It's free to get started, and you control the privacy of your charts.
+
+2 - Store your Chart Studio authentication credentials as environment variables in your R session

+Your Chart Studio authentication credentials consist of your Chart Studio username and your Chart Studio API key, which can be found [in your online settings](https://plot.ly/settings/api). 
+
+Use the [`Sys.setenv()`](https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/Sys.setenv) function to set these credentials as environment variables in your R session.
+
+```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 if you want them to be run every time you start a new R session.
+
+3 - Use the `api_create()` function to publish R charts to Chart Studio:
+
+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 behavior:
+
+When following the instructions above, executing `api_create(p)` will auto open the created Chart Studio 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
+
+### Where To Find Your API Key
+
+Your API key for your free Chart Studio account will be different than the API key for your [Chart Studio Enterprise](https://plot.ly/product/enterprise/) account. 
+
+Visit  to find your Chart Studio Enterprise account API key. 
+
+Remember to replace "your-company.com" with the URL of your company's Chart Studio Enterprise server.
+
+### Set the `plotly_domain` environment variable
+
+The URL that the `plotly` package uses to communicate with Chart Studio will be different if your company has a Chart Studio Enterprise server. In order to make your R session aware of the new URL, set the `plotly_domain` environment variable equal to the URL of your Chart Studio Enterprise server using the `Sys.setenv()` function. 
+
+Save the following command in your [.Rprofile](http://www.statmethods.net/interface/customizing.html) so that it runs every time you start a new R session:
+
+```r
+Sys.setenv("plotly_domain"="https://plotly.your-company.com")
+```
+
+Remember to replace "your-company" with the URL of your company's Chart Studio Enterprise server.
+
+## 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. 
+
+### Appending Static Image File Types to Chart Studio Plot URLs
+
+You can also view the static image version of any public Chart Studio graph by appending `.png` or `.jpeg` to the end of the URL for the graph. 
+
+For example, view the static image of  at . 
+
+[Chart Studio Enterprise](https://plot.ly/online_chart_maker) users can also use this method to get static images in the `.pdf`, `.svg`, and `.eps` file formats. 
+
+## Private Charts In Chart Studio
+
+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/)
diff --git a/_posts/r/chart-studio/output.png b/_posts/r/chart-studio/output.png
deleted file mode 100644
index 3397b7754071..000000000000
Binary files a/_posts/r/chart-studio/output.png and /dev/null differ
diff --git a/_posts/r/chart-studio/sending-data/2015-04-09-sending-data_index.html b/_posts/r/chart-studio/sending-data/2015-04-09-sending-data_index.html
index 427932e4f055..8433a60f3719 100644
--- a/_posts/r/chart-studio/sending-data/2015-04-09-sending-data_index.html
+++ b/_posts/r/chart-studio/sending-data/2015-04-09-sending-data_index.html
@@ -4,7 +4,7 @@
 display_as: chart_studio
 language: r
 layout: base
-name: Sending Data to Charts
+name: Sending Data to Chart Studio Graphs
 order: 8
 permalink: r/sending-data-to-charts/
 thumbnail: thumbnail/ff-subplots.jpg
diff --git a/front-matter-ci.py b/front-matter-ci.py
index 551d8ddcd855..0e0f8131a80d 100644
--- a/front-matter-ci.py
+++ b/front-matter-ci.py
@@ -77,6 +77,12 @@ def check_noTrailingSlash(meta_to_check):
                 failures.append(meta["permalink"])
     return "do any permalinks not end with a trailing slash?", failures
 
+def check_no_example_index_with_order_under_5(meta_to_check):
+    failures = []
+    for meta in meta_to_check:
+        if meta["order"] < 5 and meta['page_type'] == "u-guide":
+            failures.append(meta['permalink'])
+    return "do any posts have order less than five but page_type: u-guide?", failures
 
 categories = [
     "file_settings",