Adding my tests and finshining the lab UofUEpiBio/PHS7045-advanced-pr…

…ogramming#39

DESCRIPTION

@@ -1,4 +1,4 @@
-Package: egpkg
+Package: egpkg2024
 Type: Package
 Title: What the Package Does in One 'Title Case' Line
 Version: 1.0
@@ -9,8 +9,12 @@ Description: One paragraph description of what the package does as
        one or more full sentences.
 License: GPL (>= 2)
 Imports: 
-    Rcpp
+    Rcpp,
+    graphics
 LinkingTo: Rcpp
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Encoding: UTF-8
+Suggests: 
+    testthat (>= 3.0.0)
+Config/testthat/edition: 3

NAMESPACE

@@ -1,5 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export(myplot)
 export(rcpp_hello_world)
+import(graphics)
 importFrom(Rcpp,evalCpp)
-useDynLib(egpkg, .registration = TRUE)
+useDynLib(egpkg2024, .registration = TRUE)

R/RcppExports.R

@@ -2,11 +2,12 @@
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
 #' Hello world from Rcpp
-#' @return A list with two vectors (`x`, `y`).
+#' @return
+#' A list with two vectors (`x`, `y`).
 #' @examples
 #' rcpp_hello_world()
 #' @export
 rcpp_hello_world <- function() {
-    .Call(`_egpkg_rcpp_hello_world`)
+    .Call(`_egpkg2024_rcpp_hello_world`)
 }
 

R/egpkg-package.R

@@ -1,3 +1,3 @@
 #' @importFrom Rcpp evalCpp
-#' @useDynLib egpkg, .registration = TRUE
+#' @useDynLib egpkg2024, .registration = TRUE
 NULL

R/myplot.R

@@ -0,0 +1,29 @@
+#' Here is the function
+#' @param x A numeric vector.
+#' @param y A numeric vector.
+#' @export
+#' @import graphics
+#' @examples
+#' # Here is an example
+#' set.seed(312)
+#' x <- rnorm(100)
+#' y <- rnorm(100)
+#' myplot(x, y)
+myplot <- function(x, y) {
+
+  if (!is.numeric(x) | !is.numeric(y)) {
+    stop("x and y must be numeric")
+  }
+
+  graphics::plot(x, y, col = "blue", pch = 19, cex = 2)
+
+  invisible(
+    list(
+      x = x,
+      y = y
+    )
+  )
+
+}
+
+

src/RcppExports.cpp

@@ -12,7 +12,7 @@ Rcpp::Rostream<false>& Rcpp::Rcerr = Rcpp::Rcpp_cerr_get();
 
 // rcpp_hello_world
 List rcpp_hello_world();
-RcppExport SEXP _egpkg_rcpp_hello_world() {
+RcppExport SEXP _egpkg2024_rcpp_hello_world() {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::RNGScope rcpp_rngScope_gen;
@@ -22,11 +22,11 @@ END_RCPP
 }
 
 static const R_CallMethodDef CallEntries[] = {
-    {"_egpkg_rcpp_hello_world", (DL_FUNC) &_egpkg_rcpp_hello_world, 0},
+    {"_egpkg2024_rcpp_hello_world", (DL_FUNC) &_egpkg2024_rcpp_hello_world, 0},
     {NULL, NULL, 0}
 };
 
-RcppExport void R_init_egpkg(DllInfo *dll) {
+RcppExport void R_init_egpkg2024(DllInfo *dll) {
     R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);
     R_useDynamicSymbols(dll, FALSE);
 }

src/rcpp_hello_world.cpp

@@ -3,7 +3,8 @@
 using namespace Rcpp;
 
 //' Hello world from Rcpp
-//' @return A list with two vectors (`x`, `y`).
+//' @return
+//' A list with two vectors (`x`, `y`).
 //' @examples
 //' rcpp_hello_world()
 //' @export

tests/testthat.R

@@ -0,0 +1,12 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
+library(testthat)
+library(egpkg2024)
+
+test_check("egpkg2024")

tests/testthat/test-myplot.R

@@ -0,0 +1,8 @@
+test_that("multiplication works", {
+
+  expect_error(myplot(1, "o"))
+  expect_error(myplot("a", 1))
+  # expect_s3_class(myplot(1,1), "list")
+  expect_silent(myplot(1,1))
+
+})