Devel

.Rbuildignore

@@ -1,3 +1,5 @@
+^renv$
+^renv\.lock$
 ^LICENSE\.md$
 ^.*\.Rproj$
 ^\.Rproj\.user$
@@ -6,3 +8,4 @@
 ^docs$
 ^pkgdown$
 ^\.lintr$
+^data-raw$

.Rprofile

@@ -0,0 +1 @@
+source("renv/activate.R")

.github/workflows/BioC-check.yaml

@@ -25,17 +25,17 @@ jobs:
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - uses: r-lib/actions/setup-r@v1
+      - uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
           http-user-agent: ${{ matrix.config.http-user-agent }}
           use-public-rspm: true
 
-      - uses: r-lib/actions/setup-r-dependencies@v1
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: rcmdcheck, BiocManager
 

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: DevelExample
 Title: A Basic R Package to Demonstrate a Cycle of Code Development
-Version: 0.0.1
+Version: 0.1.0
 Authors@R: 
     person(given = "Joshua",
            family = "Campbell",
@@ -15,10 +15,12 @@ Encoding: UTF-8
 biocViews: Clustering
 LazyData: false
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.2.3
 Suggests: 
     knitr,
     rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 VignetteBuilder: knitr
+Depends: 
+    R (>= 2.10)

NEWS.md

@@ -1,5 +1,3 @@
-# Changes in Version 0.0.1 (2022-05-08)
-* Created package
-* Added Hello World function
-* Added documentation, unit tests, and vignettes
-* Added a `NEWS.md` file to track changes to the package.
+# DevelExample 0.1.0
+
+* Initial CRAN submission.

R/data.R

@@ -0,0 +1,11 @@
+#' Example dataset
+#'
+#' A dataset containing a matrix with two columns that were generated
+#' with a random normal distribution with a mean of 0 and stdev of 1. 
+#'
+#' @format A matrix with 100 rows and 2 columns
+#' @keywords datasets
+#' @usage data("example_data")
+#' @examples
+#' data("example_data")
+"example_data"

R/distance.R

@@ -0,0 +1,19 @@
+euclideanDist <- function(a, b, verbose = FALSE) {
+  if (isTRUE(verbose)) {
+    message("Calculating distance ...")
+  }
+
+  # Check validity of data
+  .check_data(a)
+  .check_data(b)
+
+  # Perform calculation
+  res <- sqrt(sum((a-b)^2))
+  return(res)
+}
+
+.check_data <- function(input) {
+  if (any(is.na(input))) {
+    stop("'input' must not contain NAs")
+  }
+}

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: ~
+template:
+  bootstrap: 5
+

data-raw/example_data.R

@@ -0,0 +1,7 @@
+## code to prepare `example_data` dataset goes here
+## code to prepare `example_data` dataset goes here
+set.seed(123)
+a <- rnorm(100)
+b <- rnorm(100)
+example_data <- cbind(a, b)
+usethis::use_data(example_data, overwrite = TRUE)