Euclidean Distance - Justin Moy Devel

.Rbuildignore

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

.github/workflows/lint.yaml

@@ -25,5 +25,5 @@ jobs:
           extra-packages: lintr
 
       - name: Lint
-        run: lintr::lint_package()
+        run: lintr::lint_package(linters = lintr::linters_with_defaults(object_name_linter = lintr::object_name_linter("camelCase")))
         shell: Rscript {0}

.gitignore

@@ -40,3 +40,7 @@ vignettes/*.pdf
 .Renviron
 inst/doc
 docs
+
+# Local libraries
+.Rprofile
+renv/

.lintr

@@ -1,4 +1,4 @@
-linters: with_defaults(
+linters: linters_with_defaults(
     object_name_linter = object_name_linter(styles = "camelCase"),
     line_length_linter(80),
     T_and_F_symbol_linter

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.1
 Suggests: 
     knitr,
     rmarkdown,
-    testthat (>= 3.0.0)
+    testthat,
 Config/testthat/edition: 3
 VignetteBuilder: knitr
+Depends: 
+    R (>= 2.10)

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
+export(euclideanDist)
 export(hello)

NEWS.md

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

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("exampleData")
+#' @examples
+#' data("exampleData")
+"exampleData"

R/distance.R

@@ -0,0 +1,32 @@
+#' @title Euclidean distance
+#' @description Calculates Euclidean distance between two vectors. An error will
+#' be given if NAs are present in either vector.
+#'
+#' @param a The first vector to use in the distance calculation.
+#' @param b The second vector to use in the distance calculation.
+#' @param verbose Boolean. If \code{TRUE}, a message will be printed.
+#' Default \code{TRUE}.
+#' @return A numeric value of a distance
+#' @examples
+#' data(exampleData)
+#' euclideanDist(exampleData[, 1], exampleData[, 2], verbose = FALSE)
+#' @export
+euclideanDist <- function(a, b, verbose = FALSE) {
+  if (isTRUE(verbose)) {
+    message("Calculating distance ...")
+  }
+
+  # Check validity of data
+  .checkData(a)
+  .checkData(b)
+
+  # Perform calculation
+  res <- sqrt(sum((a - b)^2))
+  return(res)
+}
+
+.checkData <- 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/exampleData.R

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