Code cleanup and document()

DESCRIPTION

@@ -2,16 +2,19 @@ Package: rmdformats
 Maintainer: Julien Barnier <[email protected]>
 Authors@R: c(person("Julien", "Barnier", email="[email protected]",
     role=c("aut","cre")))
-Version: 0.1.1
-Date: 2014-11-03
+Version: 0.1
+Date: 2015-12-04
 License: GPL (>= 2)
 Encoding: UTF-8
-Title: HTML output formats for RMarkdown documents
+Title: HTML Output Formats and Templates for RMarkdown Documents
 Description: HTML formats and templates for RMarkdown documents, with some extra
-    features such as automatic table of contents and lightboxed figures.
+    features such as automatic table of contents, lightboxed figures, dynamic
+    crosstab helper.
 Imports:
-    questionr,
     knitr,
     rmarkdown,
     htmltools
+Suggests:
+    questionr
 URL: https://github.com/juba/rmdformats
+RoxygenNote: 5.0.1

NAMESPACE

@@ -1,15 +1,16 @@
-# Generated by roxygen2 (4.1.0): do not edit by hand
+# Generated by roxygen2: do not edit by hand
 
 S3method(print,pilltabs)
 export(create.doc)
 export(html_clean)
 export(html_docco)
 export(knit_print.pilltabs)
 export(pilltabs)
-import(htmltools)
 import(rmarkdown)
+importFrom(htmltools,htmlDependency)
 importFrom(knitr,asis_output)
 importFrom(knitr,kable)
+importFrom(knitr,opts_knit)
 importFrom(questionr,chisq.residuals)
 importFrom(questionr,cprop)
 importFrom(questionr,rprop)

R/html_clean.R

@@ -10,9 +10,7 @@
 #'   "zenburn", "haddock", and "textmate". Pass \code{NULL} to prevent syntax
 #'   highlighting.
 #' @param ... Additional function arguments passed to R Markdown \code{\link{html_document}}
-#'
 #' @return R Markdown output format to pass to \code{\link{render}}
-#'
 #' @examples
 #' \dontrun{
 #'
@@ -21,10 +19,9 @@
 #' render("input.Rmd", html_clean())
 #' 
 #' }
-#'
-#' @export
 #' @import rmarkdown
-#' @import htmltools
+#' @importFrom htmltools htmlDependency
+#' @export
 
 
 html_clean <- function(fig_width = 6,
@@ -48,7 +45,7 @@ html_clean <- function(fig_width = 6,
                    "--variable", paste0("mathjax-url:", rmarkdown:::default_mathjax()))
 
   rmarkdown::html_document(
-      template=system.file("templates/html_clean/default.html", package="rmdformats"),
+      template = system.file("templates/html_clean/default.html", package = "rmdformats"),
       extra_dependencies = extra_dependencies,
       fig_width = fig_width,
       fig_height = fig_height,
@@ -64,23 +61,23 @@ html_clean <- function(fig_width = 6,
 html_dependency_jquery_ui <- function() {
   htmltools::htmlDependency(name = "jquery-ui",
                  version = "1.10.4",
-                 src = system.file("templates/jquery-ui-1.10.4", package="rmdformats"),
+                 src = system.file("templates/jquery-ui-1.10.4", package = "rmdformats"),
                  script = "jquery-ui-1.10.4.custom.min.js")
 }
 
 # create an html dependency for tocify
 html_dependency_tocify <- function() {
   htmltools::htmlDependency(name = "tocify",
                  version = "1.9.0",
-                 src = system.file("templates/tocify-1.9.0", package="rmdformats"),
+                 src = system.file("templates/tocify-1.9.0", package = "rmdformats"),
                  script = "jquery.tocify.min.js")
 }
 
 # create an html dependency for Maginfic popup
 html_dependency_magnific_popup <- function() {
   htmltools::htmlDependency(name = "magnific-popup",
                  version = "0.9.9",
-                 src = system.file("templates/magnific-popup-0.9.9", package="rmdformats"),
+                 src = system.file("templates/magnific-popup-0.9.9", package = "rmdformats"),
                  script = "jquery.magnific-popup.min.js",
                  stylesheet = "magnific-popup.css")
 }
@@ -89,7 +86,7 @@ html_dependency_magnific_popup <- function() {
 html_dependency_clean <- function() {
   htmltools::htmlDependency(name = "clean",
                  version = "0.1",
-                 src = system.file("templates/html_clean", package="rmdformats"),
+                 src = system.file("templates/html_clean", package = "rmdformats"),
                  script = "clean.js",
                  stylesheet = "clean.css")
 }

R/html_docco.R

@@ -10,21 +10,15 @@
 #'   "zenburn", "haddock", and "textmate". Pass \code{NULL} to prevent syntax
 #'   highlighting.
 #' @param ... Additional function arguments passed to R Markdown \code{\link{html_document}}
-#'
 #' @return R Markdown output format to pass to \code{\link{render}}
-#'
 #' @examples
 #' \dontrun{
-#'
 #' library(rmdformats)
-#'
 #' render("input.Rmd", html_docco())
-#' 
 #' }
-#'
-#' @export
 #' @import rmarkdown
-#' @import htmltools
+#' @importFrom htmltools htmlDependency
+#' @export
 
 html_docco <- function(fig_width = 6,
                        fig_height = 6,
@@ -45,7 +39,7 @@ html_docco <- function(fig_width = 6,
                    "--variable", paste0("mathjax-url:", rmarkdown:::default_mathjax()))
 
   rmarkdown::html_document(
-    template=system.file("templates/html_docco/default.html", package="rmdformats"),
+    template = system.file("templates/html_docco/default.html", package = "rmdformats"),
     extra_dependencies = extra_dependencies,
     fig_width = fig_width,
     fig_height = fig_height,
@@ -62,7 +56,7 @@ html_docco <- function(fig_width = 6,
 html_dependency_magnific_popup <- function() {
   htmltools::htmlDependency(name = "magnific-popup",
                  version = "0.9.9",
-                 src = system.file("templates/magnific-popup-0.9.9", package="rmdformats"),
+                 src = system.file("templates/magnific-popup-0.9.9", package = "rmdformats"),
                  script = "jquery.magnific-popup.min.js",
                  stylesheet = "magnific-popup.css")
 }
@@ -71,7 +65,7 @@ html_dependency_magnific_popup <- function() {
 html_dependency_docco <- function() {
   htmltools::htmlDependency(name = "docco",
                  version = "0.1",
-                 src = system.file("templates/html_docco", package="rmdformats"),
+                 src = system.file("templates/html_docco", package = "rmdformats"),
                  script = "docco.js",
                  stylesheet = "docco.css")
 }

R/pilltabs.R

@@ -15,13 +15,17 @@
 #' @return
 #' No value is returned.
 #' @author Julien Barnier <julien.barnier@@ens-lyon.fr>
-#' @export
-#' @importFrom questionr cprop rprop chisq.residuals
 #' @importFrom knitr kable asis_output
+#' @importFrom questionr cprop rprop chisq.residuals
+#' @export
 
 
 pilltabs <- function(tab, count=TRUE, rows=TRUE, cols=TRUE, chisq=TRUE, resid=TRUE, row.names=TRUE) {
 
+  if (!requireNamespace("questionr", quietly = TRUE))
+    stop("the questionr package is needed for the pilltabs() function to work. Please install it.",
+         call. = FALSE)  
+
     res <- list()
 
     if (count) res[["count"]] <- kable(tab, output=FALSE, row.names=row.names)