docs, pkgdown, bump version

davebraze · Jul 20, 2017 · 5c77771 · 5c77771
1 parent 5ff40a6
commit 5c77771
Show file tree

Hide file tree

Showing 24 changed files with 266 additions and 59 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: FDButils
 Title: Low Level Utility Functions
-Version: 0.0.7
-Date: 2017-04-29
+Version: 0.0.8
+Date: 2017-07-20
 Authors@R: c(person("David", "Braze", email="[email protected]", role=c("aut", "cre")))
 Maintainer: Maintainer: David Braze <[email protected]>
 Description: Stable low level utility functions, mostly for use in other FDB
@@ -14,7 +14,7 @@ License: MIT + file LICENSE
 LazyData: true
 URL: https://github.com/davebraze/FDButils
 BugReports: https://github.com/davebraze/FDButils/issues
-Collate: 
+Collate:
     'FDButils.R'
     'compCorr.R'
     'factors.R'

diff --git a/R/factors.R b/R/factors.R
@@ -44,9 +44,9 @@ fact2char <- function(f) {
 ##'
 ##' @description None yet.
 ##'
-##' @details Reorders the levels of factor f as specified in new.order, which must contain all and
-##' only the existing levels of f (including unused levels), but in the desired order. If new.order
-##' and levels(f) do not contain exactly the same elements, then do nothing.
+##' @details Reorders the levels of factor f as specified in \code{new.order}, which must contain all and
+##' only the existing levels of f (including unused levels), but in the desired order. If \code{new.order}
+##' and \code{levels(f)} do not contain exactly the same elements, then do nothing.
 ##'
 ##' @param f A factor.
 ##' @param new.order A character vector containing all and only the levels of f, in the desired order.

diff --git a/R/invDnorm.R b/R/invDnorm.R
@@ -4,7 +4,8 @@
 ##'     inverse.
 ##'
 ##' @details
-##' Cribbed from <http://stackoverflow.com/questions/19589191/the-reverse-inverse-of-the-normal-distribution-function-in-r>
+##' Cribbed from \url{http://stackoverflow.com/questions/19589191/the-reverse-inverse-of-the-normal-distribution-function-in-r}.
+##'
 ##' @param x A numeric vector.
 ##' @return A vector the same length as x.
 ##' @author Dave Braze \email{davebraze@@gmail.com}
@@ -19,6 +20,7 @@ invDnorm <- function(x) {
 }
 
 ##' @details
+##'
 ##' \code{inv_dnorm()} is deprecated.
 ##' @rdname invDnorm
 ##' @export

diff --git a/R/isNumeral.R b/R/isNumeral.R
@@ -5,7 +5,8 @@
 ##' @details
 ##' Checks element-wise as to whether each item in a vector of strings can be coerced to numeric.
 ##'
-##' Basics cribbed from \url{http://rosettacode.org/wiki/Determine_if_a_string_is_numeric#R}
+##' Basics cribbed from \url{http://rosettacode.org/wiki/Determine_if_a_string_is_numeric#R}.
+##'
 ##' @param c A vector of strings.
 ##' @return A vector of logicals, NA where \code{is.na(c)}.
 ##' @author David Braze \email{davebraze@@gmail.com}
@@ -21,7 +22,9 @@ isNumeral <- function(c) {
     retval
 }
 
-##' @details \code{is.numeral()} is deprecated.
+##' @details
+##'
+##' \code{is.numeral()} is deprecated.
 ##' @rdname isNumeral
 ##' @export
 is.numeral <- function(c) {

diff --git a/R/isWholeNumber.R b/R/isWholeNumber.R
@@ -15,7 +15,9 @@ isWholeNumber <- function(v, tol = .Machine$double.eps^0.5) {
     abs(v - round(v)) < tol
 }
 
-##' @details \code{is.wholenumber()} is deprecated.
+##' @details
+##'
+##' \code{is.wholenumber()} is deprecated.
 ##' @rdname isWholeNumber
 ##' @export
 is.wholenumber <- function(v, tol) {

diff --git a/R/latinsq.R b/R/latinsq.R
@@ -1,14 +1,14 @@
-##' @title Latin squares.
+##' @title Create Latin squares.
 ##'
-##' @description Get list of different latin squares.
+##' @description Get list of random latin squares.
 ##'
-##' @details Get list of different latin squares.
+##' @details Get list of random latin squares. At present, these are not guaranteed to be unique.
 ##'
 ##' @param nSquares Number of latin squares to create.
 ##' @param nDims Size of latin squares.
-##' @return A list of nSquares latin squares, each nDim x nDim in size.
+##' @return A list of latin squares, nSquares in length. Each square is nDims x nDims in size.
 ##' @author David Braze \email{davebraze@@gmail.com}
-##' @seealso magic::latin()
+##' @seealso \code{\link[magic]{latin}}
 ##' @export
 ##' @examples
 ##' d <- 5

diff --git a/R/nobs.R b/R/nobs.R
@@ -2,8 +2,8 @@
 ##'
 ##' @description Count non-missing values in v.
 ##'
-##' @details
-##' Returns the number of non-missing values in vector v. A convenience wrapper around sum(!is.na(v)).
+##' @details Returns the number of non-missing values in vector v. A convenience wrapper around
+##'     \code{sum(!is.na(v))}.
 ##'
 ##' @param v A vector.
 ##' @return integer, length of x minus the number of NAs in x.

diff --git a/R/outliers.R b/R/outliers.R
@@ -5,7 +5,7 @@
 ##' @details Takes a numeric vector, x, and returns a corresponding
 ##'     logical vector the same length as x. Values of TRUE in return
 ##'     vector indicate corresponding value in x may be an
-##'     outlier. Handy for use with dplyr::mutate().
+##'     outlier. Handy for use with \code{dplyr::mutate()}.
 ##'
 ##'     If method is boxplot, then values more than \code{coef} times
 ##'     the IQR above the 3rd quartile, or more than \code{coef} times

diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/invDnorm.html b/docs/reference/invDnorm.html
diff --git a/docs/reference/isNumeral.html b/docs/reference/isNumeral.html
diff --git a/docs/reference/latinList.html b/docs/reference/latinList.html
diff --git a/docs/reference/levelOrder.html b/docs/reference/levelOrder.html
diff --git a/docs/reference/mahalDistC-7.png b/docs/reference/mahalDistC-7.png
diff --git a/docs/reference/mahalDistC.html b/docs/reference/mahalDistC.html
diff --git a/docs/reference/mahalDistP-2.png b/docs/reference/mahalDistP-2.png