Docs - add README, help(summarywidget) links to docs, copyedit

kent37 · Mar 24, 2017 · 092e67c · 092e67c
1 parent 04c0863
commit 092e67c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/R/summarywidget.R b/R/summarywidget.R
@@ -18,6 +18,7 @@
 #' @import htmlwidgets
 #'
 #' @export
+#' @seealso \url{https://kent37.github.io/summarywidget}
 summarywidget <- function(data,
                           statistic=c("count", "sum", "mean"), column = NULL,
                           selection=NULL, digits=0,

diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+SummaryWidget is an [HTML widget](http://www.htmlwidgets.org) which works with
+[Crosstalk](https://rstudio.github.io/crosstalk/index.html) to display a single
+summary statistic. The statistic updates when the Crosstalk selection changes. A SummaryWidget can display the count, sum or mean of one column of selected data.
+It can also have a fixed filter that selects a subset of the full dataset.
+
+For more information and examples see the
+[full documentation](https://kent37.github.io/summarywidget).
diff --git a/man/summarywidget.Rd b/man/summarywidget.Rd