fill out DESCRIPTION and barely document

timelyportfolio · May 1, 2015 · 084c6b4 · 084c6b4
1 parent 8f1e666
commit 084c6b4
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 6 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,10 +1,26 @@
 Package: materializeR
-Title: What the package does (one line)
+Title: materialize front-end web framework as an htmlwidget in R
 Version: 0.1
-Authors@R: "First Last <first.last@example.com> [aut, cre]"
-Description: What the package does (one paragraph)
+Authors@R: c(
+    person(
+      "materialize", "team", role = c("aut", "cph"),
+      comment = "materialize library in htmlwidgets/lib, http://materializecss.com"
+    ),
+    person(
+      "jQuery", "Foundation", role = c("aut", "cph"),
+      comment = "jQuery library in htmlwidgets/lib, http://jquery.com"
+    ),
+    person(
+      "Kenton", "Russell", role = c("aut", "cre"),
+      comment = "R interface", email = "kent.russell@timelyportfolio.com"
+    )
+  )
+Maintainer: Kent Russell<kent.russell@timelyportfolio.com>
+Description: This package makes the materialize JS/CSS/HTML framework
+              easily accessible in R with the convenience, flexibility, and awareness
+              of an htmlwidget.
 Depends: R (>= 3.1.2)
-License: What license is it under?
+License: MIT + file LICENSE
 LazyData: true
 Suggests: knitr
 VignetteBuilder: knitr
diff --git a/R/materialize.R b/R/materialize.R
@@ -1,6 +1,14 @@
 #' Add \href{http://materializecss.com/}{materialize} to your R
 #'
-#' <Add Description>
+#' One and only function offered by \code{materializeR}.  The \code{...} is offered but really not all that helpful
+#' currently except for one secret power.  Use of the package \code{htmltools}
+#' from RStudio is a highly encouraged ally for \code{materializeR}.
+#'
+#' @param ... expansion room.  The \code{...} currently are a placeholder for future functionality.
+#' @param width \code{integer} width in pixel for container.  \code{width = 0} since the expectation is
+#'          for the container to be an invisible byproduct.
+#' @param height \code{integer} heightin pixel for container.  \code{height = 0} since the expectation is
+#'          for the container to be an invisible byproduct.
 #'
 #' @import htmlwidgets
 #'

diff --git a/man/materialize.Rd b/man/materialize.Rd
@@ -6,7 +6,18 @@
 \usage{
 materialize(..., width = 0, height = 0)
 }
+\arguments{
+\item{...}{expansion room.  The \code{...} currently are a placeholder for future functionality.}
+
+\item{width}{\code{integer} width in pixel for container.  \code{width = 0} since the expectation is
+for the container to be an invisible byproduct.}
+
+\item{height}{\code{integer} heightin pixel for container.  \code{height = 0} since the expectation is
+         for the container to be an invisible byproduct.}
+}
 \description{
-<Add Description>
+One and only function offered by \code{materializeR}.  The \code{...} is offered but really not all that helpful
+currently except for one secret power.  Use of the package \code{htmltools}
+from RStudio is a highly encouraged ally for \code{materializeR}.
 }
 
diff --git a/vignettes/getting_started.Rmd b/vignettes/getting_started.Rmd
@@ -135,5 +135,6 @@ Thanks so much
 
 - the geniuses Alvin Wang, Alan Chang, Alex Mark, Kevin Louie behind [`materialize`](http://materializecss.com)
 - Google for Material Design
+- jQuery Foundation
 - Ramnath Vaidyanathan and RStudio for `htmlwidgets`
 - all the contributors to `R` and `JavaScript`