Permalink
Browse files

add goals to README and minor documentation clean up

  • Loading branch information...
1 parent 7ef17ff commit df601c83abd06bced6012c8eb2a98390d6e51bba @ankitrohatgi committed May 14, 2015
Showing with 19 additions and 8 deletions.
  1. +3 −3 R/digitizeR.R
  2. +13 −2 README.md
  3. +3 −3 man/wpd.launch.Rd
View
@@ -42,9 +42,9 @@ NULL
#' @return Server handle that is later used to shutdown the server using wpd.close()
#' @export
#' @examples
-#' app = wpd.launch()
-#' app = wpd.launch(port=8080)
-#' app = wpd.launch(location="192.168.1.100", port=8080)
+#' app <- wpd.launch()
+#' app <- wpd.launch(port=8080)
+#' app <- wpd.launch(location="192.168.1.100", port=8080)
wpd.launch <- function(location = '0.0.0.0', port = 8000) {
app <- new.env()
View
@@ -24,7 +24,7 @@ No real-time communication has been implemented at the moment, but you can launc
Launch a local instance of WebPlotDigitizer:
- app = wpd.launch()
+ app <- wpd.launch()
This starts a httpuv based server on your machine. This should also open the local URL in a browser window.
@@ -34,8 +34,19 @@ Close server instance:
Change default server location and port:
- app = wpd.launch(location="192.168.1.100", port=8080) # for example
+ app <- wpd.launch(location="192.168.1.100", port=8080) # for example
+Goals
+-----
+
+At the moment, this package only lets you start (and stop) WebPlotDigitizer, but eventually, I would like to add R functions that can communicate with the app in real-time (using WebSockets). A few examples of what is possible in the future is as follows:
+
+ ds <- wpd.getDatasets(app) # fetch all digitized data as a data frame.
+ wpd.loadImage(app, 'my_plot.jpg') # load an image file programmatically.
+ wpd.loadPDF(app, 'thesis.pdf', page=5) # load a specific page from a PDF file.
+ wpd.calibrate(app, 'calibration_data.json') # align the axes to pixels using some calibration data.
+
+ # and so on.
Contact
-------
View
@@ -20,8 +20,8 @@ Start a local HTTP server that hosts WebPlotDigitizer.
This will also open a browser window pointing to the local URL.
}
\examples{
-app = wpd.launch()
-app = wpd.launch(port=8080)
-app = wpd.launch(location="192.168.1.100", port=8080)
+app <- wpd.launch()
+app <- wpd.launch(port=8080)
+app <- wpd.launch(location="192.168.1.100", port=8080)
}

0 comments on commit df601c8

Please sign in to comment.