package-wide doc

See #8

R/stanirs-package.R

@@ -0,0 +1,27 @@
+#' @docType package
+#' @name stanirs-package
+#' @aliases stanirs
+#'
+#' @title Package for working with fNIRS files
+#'
+#' @description
+#' Working with fNIRS files in Stanford's Center for Interdisciplinary Brain Sciences.
+#'
+#' TODO: consider adding links to funders.
+#'
+#' @note
+#' The most recent development version is available through [GitHub](https://github.com/OuhscBbmc/referral-exposure) by
+#' running.
+#'
+#' `devtools::install_github('cibsr/stanirs')`
+#' (make sure [devtools](https://cran.r-project.org/package=devtools) is already installed).
+#' If you're having trouble with the package, please install the development version.  If this doesn't solve
+#' your problem, please create a [new issue](https://github.com/cibsr/stanirs/issues), or email Andrey.
+#'
+#' @examples
+#' \dontrun{
+#' # Install/update ReferralExposure with the development version from GitHub
+#' #install.packages('devtools') #Uncomment if `devtools` isn't installed already.
+#' devtools::install_github('cibsr/stanirs')
+#' }
+NULL