Merge branch 'issue-5' into develop (close #5)

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: permChacko
 Title: Chacko Test for Order-Restriction with Permutation
-Version: 0.1.0.9001
+Version: 0.1.0.9002
 Authors@R:
     c(
         person(

NEWS.md

@@ -2,6 +2,7 @@
 
 * Replaced `verbose` with `verbosity` in functions to allow for more control over the output ([issue #3](https://github.com/ocbe-uio/permChacko/issues/3)).
 * Exported `reduceVector()` ([issue #4](https://github.com/ocbe-uio/permChacko/issues/4)).
+* Added package documentation ([issue #5](https://github.com/ocbe-uio/permChacko/issues/5)).
 
 # permChacko 0.1.0
 

R/onAttach.R

@@ -0,0 +1,16 @@
+#' @title Prints welcome message on package attachment
+#' @description Prints package version number and welcome message on package
+#' load
+#' @param libname library location. See `?base::.onAttach` for details
+#' @param pkgname package name. See `?base::.onAttach` for details
+.onAttach <- function(libname, pkgname) {
+  version <- read.dcf(
+    file   = system.file("DESCRIPTION", package = pkgname),
+    fields = "Version"
+  )
+  packageStartupMessage(
+    "This is ", paste(pkgname, version), "\n",
+    "To learn more about the package, please run help(\"permChacko-package\")",
+    " and help(\"permChacko\")."
+  )
+}

R/permChacko-package.R

@@ -0,0 +1,7 @@
+#' @keywords internal
+#' @aliases permChacko-package
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL