Merge pull request #163 from danforthcenter/docs-update

Docs update

Author: joshqsumner

R/conjugate.R

@@ -84,7 +84,7 @@
 #'     where shape and scale are the respective parameters of the gamma distributed rate
 #'     (inverse of scale) parameter of gamma distributed data.}
 #'    \item{\strong{"poisson" and "exponential": } \code{priors = list(a = 0.5,b = 0.5)},
-#'     where a and b are shape parameters of the gamma distribution.}
+#'     where a and b are shape and rate parameters of the gamma distribution.}
 #'    \item{\strong{"negbin": } \code{priors = list(r = 10, a = 0.5, b = 0.5)},
 #'     where r is the r parameter of the negative binomial distribution
 #'     (representing the number of successes required)

R/pcvr-package.R

@@ -0,0 +1,25 @@
+#' Plant Phenotyping and Bayesian Statistics
+#'
+#' @name pcvr-package
+#' @aliases pcvr
+#'
+#' @description
+#' \if{html}{
+#'    \figure{pcvr_logo.png}{options: width="100" alt="logo" style="float: right"}
+#' }
+#'
+#' The \pkg{pcvr} package is meant to interface with any datatypes returned from \pkg{PlantCV}
+#' including single and multi value trait phenotypes as well as common metadata for plant science
+#' experiments as well as lower the barrier to entry for select Bayesian statistics and longitudinal
+#' models of particular use in plant science.
+#'
+#'
+#' @seealso
+#' Useful links:
+#' \itemize{
+#' \item \url{https://plantcv.org}
+#' \item Report bugs at \url{https://github.com/danforthcenter/pcvr}
+#' }
+#' \code{\link{growthSS}}
+#' \code{\link{conjugate}}
+"_PACKAGE"

_pkgdown.yml

@@ -174,3 +174,4 @@ reference:
       - summary.conjugate
       - plot.conjugate
       - conjugate-class
+      - pcvr-package