Add docs/source/r.rst

docs/source/r.rst

@@ -0,0 +1,219 @@
+*******
+R
+*******
+
+QuartzMap supports creating of a number of R HTML applications:
+
+1. R Leaflet:  https://github.com/rstudio/leaflet/
+
+2. Plotly:  https://plotly.com/r/
+
+3. Standard Plots
+
+.. contents:: Table of Contents
+
+
+R Leaflet
+===================================
+
+To create an R Leaflet Map, click on "Add New" button.
+
+   .. image:: images/Add-Map.png
+
+
+There are three options for creating a Map.
+
+
+Option 1: FTP.
+------------
+
+FTP Uploads are qgis2web maps you have uploaded directly via FTP.
+
+It can also maps you uploaded via any FTP client.
+
+   .. image:: images/Map-2.png
+
+
+Option 2: Archive (Upload)
+------------
+
+Archive is a zipped archive file you can upload.
+
+
+   .. image:: images/Map-3.png
+
+
+Option 3: Paste
+------------
+
+Paste your R Leaflet code into the code box.
+
+
+   .. image:: images/Map-3.png
+
+
+Options:
+
+Name
+--------------
+
+Give your map a name.  The name will appear as the map title on the dashboard.
+
+.. image:: images/Name-Desc.png
+
+
+Description
+--------------
+
+The Description is the text that will appear at the bottom of the map link
+
+.. image:: images/Name.png
+
+
+
+R Plotly
+===================================
+
+There are three options for creating a Map.
+
+
+Option 1: FTP.
+------------
+
+FTP Uploads are qgis2web maps you have uploaded directly via FTP.
+
+It can also maps you uploaded via any FTP client.
+
+   .. image:: images/Map-2.png
+
+
+Option 2: Archive (Upload)
+------------
+
+Archive is a zipped archive file you can upload.
+
+
+   .. image:: images/Map-3.png
+
+
+Option 3: Paste
+------------
+
+Paste your R Leaflet code into the code box.
+
+
+   .. image:: images/Map-3.png
+
+
+
+Name
+--------------
+
+Give your map a name.  The name will appear as the map title on the dashboard.
+
+.. image:: images/Name-Desc.png
+
+
+Description
+--------------
+
+The Description is the text that will appear at the bottom of the map link
+
+.. image:: images/Name.png
+
+
+
+Data
+--------------
+
+The Data section is where you can connect your map layers to their Data Sources to make them dynamic.
+
+.. image:: images/PostGIS-Select.png
+
+
+Layer Cache
+--------------
+
+When you connect your map to a PostGIS Data Source, you have the option of caching layers for better performance.
+
+By default, cache is disabled.
+
+You can enable caching on a per Layer basis by specifying the cache interval.
+
+When set, this is the interval at which your map will check the database for updates.
+
+.. image:: images/cache.png
+
+If you have enabled cache and wish to clear it, you can do so by clicking the Clear Cache icon on the Map page:
+
+.. image:: images/clear-cache.png
+
+
+QGIS Project File:
+--------------
+
+You can upload your QGIS Project file in order to use WMS, WFS, and WMTS
+
+.. image:: images/QGIS-Project-File.png
+
+Map CSS:
+--------------
+
+Enter any custom CSS for your map that wish to.
+
+.. image:: images/CSS.png
+
+Thumbnail Image:
+--------------
+
+Upload a thumbnail image for your map to be displayed on the home page.
+
+.. image:: images/Thumbnail.png
+
+Data Tables:
+--------------
+
+Check the "Show Data Tables" box in order to provide users with data in table format.
+
+.. image:: images/Show-Data-Table.png
+
+
+Info Box.
+--------------
+
+The InfoBox is a modal information box you can display to map users.
+
+.. image:: images/Info-Box.png
+
+
+Security
+--------------
+
+Maps can be Private or Public.
+
+The Security section is where you assign permissions to your map.
+
+Security is Group based, so any users belonging to the Group will be able to view the map.
+
+.. image:: images/users-3.jpg
+
+1. Private Maps
+
+Private maps can be viewed by the user logging into your map portal or via Secure Share link (for temporary access)
+
+For example, since we gave access to the Group containing user Jane Doe, when she logs in she will see only the two maps she has permissions to
+
+.. image:: images/users-2.jpg
+
+2. Public Maps
+
+You can also tick the “Public” box to make your map public.
+
+.. image:: images/public-users.jpg
+
+If your map is “Public”, you can use the map url to display the map.
+
+By default, the map is full screen. You can also use an iframe like below:
+
+.. image:: images/public-map.png
+