update of pkgdown doc and added license

laderast · Jan 11, 2019 · 5f7d993 · 5f7d993
1 parent 397ee45
commit 5f7d993
Show file tree

Hide file tree

Showing 28 changed files with 1,127 additions and 31 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,3 +1,4 @@
+^LICENSE\.md$
 ^docs$
 ^_pkgdown\.yml$
 ^CODE_OF_CONDUCT\.md$

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,7 +5,7 @@ Version: 0.1.0
 Author: Ted Laderas
 Maintainer: Ted Laderas <ted.laderas@gmail.com>
 Description: Allows the teacher to deploy a simple data exploration app for exploring a dataset (mostly for teaching purposes).
-License: What license is it under?
+License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 Imports: 

diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,2 @@
+YEAR: 2019
+COPYRIGHT HOLDER: Ted Laderas
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2019 Ted Laderas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/R/xplor.R b/R/xplor.R
@@ -1,12 +1,22 @@
-#' Title
+#' Explore a dataaset using a simple app
 #'
 #' @param dataset - a data frame
 #' @param covariates - Optional. a character vector of column names you want
 #' to include in the dataset
 #' @param outcome_var - a categorical variable that describes an outcome to examine
 #'
+#' `explore_data` gives you a simple shiny app to explore data, The app is tailored to the
+#'  covariate types of the data.frame/data.table that you pass to it.
+#'
+#'  Each menu item covers a different part of exploratory data analysis with
+#'  simple visualizations for discussion.
+#'
+#'  The tabs are automatically updated with variables depending on the variable types.
+#'
+#'
 #' @return A Shiny App object that can either be run in the console or on an external
-#' shiny server such as shinyapps.io
+#' shiny server such as shinyapps.io. For building the actual app.R, see
+#' build_shiny_app
 #' @export
 #' @import shiny
 #' @import shinydashboard
@@ -17,9 +27,10 @@
 #' @examples
 #' library(ggplot2)
 #' data(diamonds)
-#' burro::explore_data(diamonds, outcome_var="Cut")
-#'
-explore_data <- function(dataset, covariates=NULL, outcome_var) {
+#' if(interactive()){
+#'    burro::explore_data(diamonds, outcome_var="cut")
+#' }
+explore_data <- function(dataset, covariates=NULL, outcome_var, data_dictionary = NULL) {
 
   dataset_name <- deparse(substitute(dataset))
 
@@ -324,7 +335,10 @@ sanitize_data_frame <- function(dataset, outcome_var){
 #' library(ggplot2)
 #' data(diamonds)
 #' covars <- colnames(diamonds)
-#' burro::build_shiny_app(dataset=diamonds, covariates=covars, outcome_var="cut")
+#' if(interactive()){
+#' burro::build_shiny_app(dataset=diamonds,
+#' covariates=covars, outcome_var="cut")
+#' }
 build_shiny_app <- function(dataset, covariates, outcome_var) {
 
   out_covar_string <- c("c(\'{outvar}\')")

diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html