From fa36925016b33e9a5326e268a2abcaac0cb94332 Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Sun, 15 May 2022 19:28:01 -0400 Subject: [PATCH 1/8] Added new function and documentation for calculating distance --- NAMESPACE | 1 + R/distance.R | 34 ++++++++++++++++++++++++++++++++++ man/euclideanDist.Rd | 25 +++++++++++++++++++++++++ 3 files changed, 60 insertions(+) create mode 100644 R/distance.R create mode 100644 man/euclideanDist.Rd diff --git a/NAMESPACE b/NAMESPACE index 01843dc..6bd620a 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,3 +1,4 @@ # Generated by roxygen2: do not edit by hand +export(euclideanDist) export(hello) diff --git a/R/distance.R b/R/distance.R new file mode 100644 index 0000000..cdd2ad6 --- /dev/null +++ b/R/distance.R @@ -0,0 +1,34 @@ +#' @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 +#' euclideanDist(c(1, 2), c(2, 3), verbose = FALSE) +#' @export +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) +} + +#' @description Check for NAs +#' +#' @param input A numeric vector +#' @return Nothing returned +.check_data <- function(input) { + if (any(is.na(input))) { + stop("'input' must not contain NAs") + } +} diff --git a/man/euclideanDist.Rd b/man/euclideanDist.Rd new file mode 100644 index 0000000..f5e51f4 --- /dev/null +++ b/man/euclideanDist.Rd @@ -0,0 +1,25 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/distance.R +\name{euclideanDist} +\alias{euclideanDist} +\title{Euclidean distance} +\usage{ +euclideanDist(a, b, verbose = FALSE) +} +\arguments{ +\item{a}{The first vector to use in the distance calculation.} + +\item{b}{The second vector to use in the distance calculation.} + +\item{verbose}{Boolean. If \code{TRUE}, a message will be printed. Default \code{TRUE}.} +} +\value{ +A numeric value of a distance +} +\description{ +Calculates Euclidean distance between two vectors. An error will be +given if NAs are present in either vector. +} +\examples{ +euclideanDist(c(1, 2), c(2, 3), verbose = FALSE) +} From 1910d7537f4877ef4c8eb45d136070a8e62b020e Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Sun, 15 May 2022 20:25:03 -0400 Subject: [PATCH 2/8] Added new example_dataset and used it in the example for the euclideanDist function --- .Rbuildignore | 1 + DESCRIPTION | 2 ++ R/data.R | 11 +++++++++++ R/distance.R | 3 ++- data-raw/example_data.R | 6 ++++++ data/example_data.rda | Bin 0 -> 2010 bytes man/euclideanDist.Rd | 3 ++- man/example_data.Rd | 20 ++++++++++++++++++++ 8 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 R/data.R create mode 100644 data-raw/example_data.R create mode 100644 data/example_data.rda create mode 100644 man/example_data.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 88b0533..6624a45 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,4 @@ ^docs$ ^pkgdown$ ^\.lintr$ +^data-raw$ diff --git a/DESCRIPTION b/DESCRIPTION index e2161da..2418b46 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -22,3 +22,5 @@ Suggests: testthat (>= 3.0.0) Config/testthat/edition: 3 VignetteBuilder: knitr +Depends: + R (>= 2.10) diff --git a/R/data.R b/R/data.R new file mode 100644 index 0000000..be00067 --- /dev/null +++ b/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" \ No newline at end of file diff --git a/R/distance.R b/R/distance.R index cdd2ad6..c34910a 100644 --- a/R/distance.R +++ b/R/distance.R @@ -7,7 +7,8 @@ #' @param verbose Boolean. If \code{TRUE}, a message will be printed. Default \code{TRUE}. #' @return A numeric value of a distance #' @examples -#' euclideanDist(c(1, 2), c(2, 3), verbose = FALSE) +#' data(example_data) +#' euclideanDist(example_data[,1], example_data[,2], verbose = FALSE) #' @export euclideanDist <- function(a, b, verbose = FALSE) { if (isTRUE(verbose)) { diff --git a/data-raw/example_data.R b/data-raw/example_data.R new file mode 100644 index 0000000..24efc73 --- /dev/null +++ b/data-raw/example_data.R @@ -0,0 +1,6 @@ +## 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) diff --git a/data/example_data.rda b/data/example_data.rda new file mode 100644 index 0000000000000000000000000000000000000000..cfdadd051565028c4850e318a879fccc388bd049 GIT binary patch literal 2010 zcmV<02PODIT4*^jL0KkKS)Rp2K>z_VfB*mg|NsC0|NsC0|NsC0|NsC0|NsC0|NsC0 z|NsC0|NqbgeqQEVJ=A7O@B$Mi$urR>lwx{~9)dka(3)+ifsICuG-;-TO*W>P2dMQ8 zGe$&hPf*BunrWtLG-%pJgVK6KO+8Ohka}bgJb=_`=trd5o~P=bNs;NMnI;f0Y7%2f z`liZerk;}#vYDpU9-}l(G{|K1Luv*_Bh>XCnns?dr1dtTqttm#FhPj)(mhX83FLz` zPbsv4=@>GeqtPCkf$AQiS z0z5zn^)aSIdI^(iW`s1+lLCIAXiNynh}sc=8UZxX>8a^5GHHZqngqzeCO}MR00000 z0Wb{!GynhrpiCnG000006HTB127mwnMhSpMOojje000D2(?}GXKtZF_XvhYDX{Hk( zG#ME*8Z>AP4XL4!G&Il+G|15FH>01X2WXnKtRG#L!i0MKX}G%^Z;#=LsQ zq*V}x|7KY#;<)Pp09-W4nFIhDL<}Gxc9aMJ=m3CI!7*?>@^y(2f&u~q9QQ=O6RXhx5pE$t6Ap02>zl-o z9o2zs(*&L|%e)EvRM^&9+@`oQPd5B{dgr3?=q[J5>4=9s&MXUdWSthKOK52(ri z8nVwH8>LWE6=myK*RnBB)}@%v(?&x{`y2c95d6QTD-s-Zsa^Oif$b)tZ>W*=LX=EM zmrgQ8;Ko;Z6-;u;~MQ`F;v>4gk8*HEsf~V$6y&~HV$tLV#w+8Bl z5xXR1YNTCqrfaU;?L38UapcbR3?xRjEw}biP!BhmEc_1Yh1nQD&$U~W485soAlYU@ z5mq07N0JIZi3n$ZyQ16?F)bV8s_skIvFp+NGoECvm34faDzKdu0u++0L9v+f4RJ6{ zv8mQ2^bAut?1ocYr@Wnj12msQPj+K1c*pP0B1^>2)r%EK1ShEh_FM|e3&P;yUc#Gq zk-0$#%Wq7a6|5iSqoTWRminYp#On9zg-95f`MhEX#}!33xf)&dQ#vGXo=NxCLg-)7 zC3s;hM#7fn@AxiVVKl+#^gbk*2HxaBI1kL6+zp)~SWo$G(uoax@Eq)p$#}P(1&4=8 zvvj%=q5wS=8>@z7<$+DGG>Lj50)ZAn_U1zjAutm#R6!OM3_Aa?fOI3u4aofV95_~J z7jS>Y8QU@u+$AFE2j_6`W!z8gUu7)v+%iAQi2^yX!=Y}!ynhuf^XY&`?Jkv1r{S8t@hf6h)TFuno zC3D>zA?(>Yr!U(MCI&J&NU^#ReVJMhdLkBvBq>!*r0t>GwX2>t5IXL4rQirfXr~I` zDXBW?5=3yCXDK28>?NpF;e~1l6&QE!Bv)duwke`&o0+M4hl8+5pOq93+j6z4BEGO^*=4y`n9_&vHIH=wR}DjJy?9dG_f?2-j5Vc(Du6(Q@I{ z(<+6bS;7|HPynX3IjjkTlq#lRt_ut^To@r%uAB>g!F8~oa1LnR2M z2PiNU?Cl{xY&gs-n@x^;2nI_lQyF{=Q&7rrMHrd4KWSlfe4D3smJl-Py6`00l-Us- zVXS#9WL;@@)5y?@hJ0V}z6RqON&Cis-GrsE-6aKZzD98C9VeO-XH{vv3hB}ULng^- z@*(Bk6i5qM1mV#=N$`a$0QfY(Z%GqDq7g(c)|84#kx@Ood=KoqG7db@cQmnJH`1$K zz%x7^4E`)Y(oB1`qzWVi>B-R(!6>(}AVVW%3u=}yM8&4pwPT2&uBOiD`JeZ`N6WX= zEsc*af=2dhn+bgo2F2QhNcdyzO_Z3QtO5J^MnWAbtc@3exti53PZgK>tb&)n@YK%IRMNE zITQx7tc!v$vV4vbUHO-Xnu*aTR=9vTulQXN*b=|AG`NT&)C6WFMTAX{&)mH+?% literal 0 HcmV?d00001 diff --git a/man/euclideanDist.Rd b/man/euclideanDist.Rd index f5e51f4..ed10e85 100644 --- a/man/euclideanDist.Rd +++ b/man/euclideanDist.Rd @@ -21,5 +21,6 @@ Calculates Euclidean distance between two vectors. An error will be given if NAs are present in either vector. } \examples{ -euclideanDist(c(1, 2), c(2, 3), verbose = FALSE) +data(example_data) +euclideanDist(example_data[,1], example_data[,2], verbose = FALSE) } diff --git a/man/example_data.Rd b/man/example_data.Rd new file mode 100644 index 0000000..e724347 --- /dev/null +++ b/man/example_data.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{example_data} +\alias{example_data} +\title{Example dataset} +\format{ +A matrix with 100 rows and 2 columns +} +\usage{ +data("example_data") +} +\description{ +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. +} +\examples{ +data("example_data") +} +\keyword{datasets} From ffcefb5ad722f10d1ae55139f74827b238d7445c Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Thu, 19 May 2022 21:49:48 -0400 Subject: [PATCH 3/8] Fixed documentation for utility function --- R/distance.R | 4 +++- man/dot-check_data.Rd | 17 +++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 man/dot-check_data.Rd diff --git a/R/distance.R b/R/distance.R index c34910a..b28b001 100644 --- a/R/distance.R +++ b/R/distance.R @@ -24,7 +24,9 @@ euclideanDist <- function(a, b, verbose = FALSE) { return(res) } -#' @description Check for NAs +#' Validity check +#' +#' This functions checks for NAs in a vector #' #' @param input A numeric vector #' @return Nothing returned diff --git a/man/dot-check_data.Rd b/man/dot-check_data.Rd new file mode 100644 index 0000000..d0e1b19 --- /dev/null +++ b/man/dot-check_data.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/distance.R +\name{.check_data} +\alias{.check_data} +\title{Validity check} +\usage{ +.check_data(input) +} +\arguments{ +\item{input}{A numeric vector} +} +\value{ +Nothing returned +} +\description{ +This functions checks for NAs in a vector +} From b42cdbfb646253c748f29e98398abe8babe2a008 Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Thu, 19 May 2022 21:53:15 -0400 Subject: [PATCH 4/8] Added unit test for euclideanDist function --- tests/testthat/test-euclidean.R | 9 +++++++++ tests/testthat/test-functions.R | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 tests/testthat/test-euclidean.R diff --git a/tests/testthat/test-euclidean.R b/tests/testthat/test-euclidean.R new file mode 100644 index 0000000..d51b9ad --- /dev/null +++ b/tests/testthat/test-euclidean.R @@ -0,0 +1,9 @@ +library("DevelExample") +data(example_data) + +test_that("Testing euclideanDist function", { + res <- dist(rbind(example_data[,1], example_data[,2]))[1] + expect_equal(euclideanDist(example_data[,1], example_data[,2]), res) + + expect_error(euclideanDist(c(1, 2), c(NA, 2)), regexp = "contain NAs") +}) diff --git a/tests/testthat/test-functions.R b/tests/testthat/test-functions.R index 5bfa2f2..d573a7c 100644 --- a/tests/testthat/test-functions.R +++ b/tests/testthat/test-functions.R @@ -5,7 +5,7 @@ test_that("multiplication works", { }) test_that("hello world message", { - expect_message(message(hello()), regexp = "Hello world.") + expect_message(message(hello()), regexp = "Hello world") }) test_that("hello world text with !", { From 86845959469b690683ddc0ba8ef1e7ab55f1d3fa Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Thu, 19 May 2022 22:11:01 -0400 Subject: [PATCH 5/8] fixed lints --- R/data.R | 4 ++-- R/distance.R | 21 +++++++++++---------- man/{dot-check_data.Rd => dot-checkData.Rd} | 6 +++--- man/euclideanDist.Rd | 7 ++++--- tests/testthat/test-euclidean.R | 6 +++--- 5 files changed, 23 insertions(+), 21 deletions(-) rename man/{dot-check_data.Rd => dot-checkData.Rd} (81%) diff --git a/R/data.R b/R/data.R index be00067..394dcb5 100644 --- a/R/data.R +++ b/R/data.R @@ -1,11 +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. +#' 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" \ No newline at end of file +"example_data" diff --git a/R/distance.R b/R/distance.R index b28b001..93f8b93 100644 --- a/R/distance.R +++ b/R/distance.R @@ -1,10 +1,11 @@ #' @title Euclidean distance -#' @description Calculates Euclidean distance between two vectors. An error will be -#' given if NAs are present in either vector. +#' @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}. +#' @param verbose Boolean. If \code{TRUE}, a message will be printed. +#' Default \code{TRUE}. #' @return A numeric value of a distance #' @examples #' data(example_data) @@ -14,23 +15,23 @@ euclideanDist <- function(a, b, verbose = FALSE) { if (isTRUE(verbose)) { message("Calculating distance ...") } - + # Check validity of data - .check_data(a) - .check_data(b) - + .checkData(a) + .checkData(b) + # Perform calculation - res <- sqrt(sum((a-b)^2)) + res <- sqrt(sum((a - b) ^ 2)) return(res) } #' Validity check -#' +#' #' This functions checks for NAs in a vector #' #' @param input A numeric vector #' @return Nothing returned -.check_data <- function(input) { +.checkData <- function(input) { if (any(is.na(input))) { stop("'input' must not contain NAs") } diff --git a/man/dot-check_data.Rd b/man/dot-checkData.Rd similarity index 81% rename from man/dot-check_data.Rd rename to man/dot-checkData.Rd index d0e1b19..28633bd 100644 --- a/man/dot-check_data.Rd +++ b/man/dot-checkData.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/distance.R -\name{.check_data} -\alias{.check_data} +\name{.checkData} +\alias{.checkData} \title{Validity check} \usage{ -.check_data(input) +.checkData(input) } \arguments{ \item{input}{A numeric vector} diff --git a/man/euclideanDist.Rd b/man/euclideanDist.Rd index ed10e85..d868d2c 100644 --- a/man/euclideanDist.Rd +++ b/man/euclideanDist.Rd @@ -11,14 +11,15 @@ euclideanDist(a, b, verbose = FALSE) \item{b}{The second vector to use in the distance calculation.} -\item{verbose}{Boolean. If \code{TRUE}, a message will be printed. Default \code{TRUE}.} +\item{verbose}{Boolean. If \code{TRUE}, a message will be printed. +Default \code{TRUE}.} } \value{ A numeric value of a distance } \description{ -Calculates Euclidean distance between two vectors. An error will be -given if NAs are present in either vector. +Calculates Euclidean distance between two vectors. An error +will be given if NAs are present in either vector. } \examples{ data(example_data) diff --git a/tests/testthat/test-euclidean.R b/tests/testthat/test-euclidean.R index d51b9ad..19ddcd0 100644 --- a/tests/testthat/test-euclidean.R +++ b/tests/testthat/test-euclidean.R @@ -2,8 +2,8 @@ library("DevelExample") data(example_data) test_that("Testing euclideanDist function", { - res <- dist(rbind(example_data[,1], example_data[,2]))[1] - expect_equal(euclideanDist(example_data[,1], example_data[,2]), res) - + res <- dist(rbind(example_data[, 1], example_data[, 2]))[1] + expect_equal(euclideanDist(example_data[, 1], example_data[, 2]), res) + expect_error(euclideanDist(c(1, 2), c(NA, 2)), regexp = "contain NAs") }) From 0d7807025cafe1bfcab7299b0120024fe583158c Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Fri, 20 May 2022 09:10:25 -0400 Subject: [PATCH 6/8] Added euclideanDist example to vignette --- vignettes/DevelExample.Rmd | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/vignettes/DevelExample.Rmd b/vignettes/DevelExample.Rmd index 170fadb..0bc4917 100644 --- a/vignettes/DevelExample.Rmd +++ b/vignettes/DevelExample.Rmd @@ -34,6 +34,19 @@ We can also run the same function but without all of the exclamation marks: hello(withExcitement = FALSE) ``` +To calculate the euclidean distance between two vectors, we can use the `euclideanDist` function. In this example we will generate two random vectors from normal distributions with two different means and calculate the distance between them: + +```{r dist} +set.seed(12345) +v1 <- rnorm(10000, mean = 1) +v2 <- rnorm(10000, mean = 2) +res <- euclideanDist(v1, v2, verbose = FALSE) +res +``` + +The `set.seed` function is used for the random number generator and ensures the same vectors will be produced each time for reproducibility. + + It is usually a good idea to show the session information to help with reproducibility: ```{r session} From 6c7a09196c3fed7552b8a2e38514c896ebed64bd Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Fri, 20 May 2022 09:36:08 -0400 Subject: [PATCH 7/8] Updated NEWS and bumped version number to 0.1.0 --- DESCRIPTION | 2 +- NEWS.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 2418b46..f663d85 100644 --- a/DESCRIPTION +++ b/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", diff --git a/NEWS.md b/NEWS.md index 4cd8ae2..86504fb 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,6 @@ +# Changes in Version 0.1.0 (2022-05-20) +* Added function to calculate euclidean distance + # Changes in Version 0.0.1 (2022-05-08) * Created package * Added Hello World function From eb388690ea73eda8a12c52a068e6af46f426375b Mon Sep 17 00:00:00 2001 From: "Joshua D. Campbell" Date: Fri, 20 May 2022 10:26:30 -0400 Subject: [PATCH 8/8] Updated pkgdown website files and removed 'docs' from .gitignore --- .gitignore | 1 - docs/404.html | 99 ++++++++ docs/LICENSE-text.html | 95 ++++++++ docs/LICENSE.html | 79 ++++++ docs/articles/DevelExample.html | 154 ++++++++++++ docs/articles/index.html | 73 ++++++ docs/authors.html | 94 ++++++++ docs/bootstrap-toc.css | 60 +++++ docs/bootstrap-toc.js | 159 +++++++++++++ docs/docsearch.css | 148 ++++++++++++ docs/docsearch.js | 85 +++++++ docs/index.html | 132 ++++++++++ docs/link.svg | 12 + docs/news/index.html | 82 +++++++ docs/pkgdown.css | 384 ++++++++++++++++++++++++++++++ docs/pkgdown.js | 108 +++++++++ docs/pkgdown.yml | 7 + docs/reference/Rplot001.png | Bin 0 -> 1011 bytes docs/reference/dot-checkData.html | 89 +++++++ docs/reference/euclideanDist.html | 103 ++++++++ docs/reference/example_data.html | 91 +++++++ docs/reference/hello.html | 96 ++++++++ docs/reference/index.html | 90 +++++++ docs/sitemap.xml | 42 ++++ 24 files changed, 2282 insertions(+), 1 deletion(-) create mode 100644 docs/404.html create mode 100644 docs/LICENSE-text.html create mode 100644 docs/LICENSE.html create mode 100644 docs/articles/DevelExample.html create mode 100644 docs/articles/index.html create mode 100644 docs/authors.html create mode 100644 docs/bootstrap-toc.css create mode 100644 docs/bootstrap-toc.js create mode 100644 docs/docsearch.css create mode 100644 docs/docsearch.js create mode 100644 docs/index.html create mode 100644 docs/link.svg create mode 100644 docs/news/index.html create mode 100644 docs/pkgdown.css create mode 100644 docs/pkgdown.js create mode 100644 docs/pkgdown.yml create mode 100644 docs/reference/Rplot001.png create mode 100644 docs/reference/dot-checkData.html create mode 100644 docs/reference/euclideanDist.html create mode 100644 docs/reference/example_data.html create mode 100644 docs/reference/hello.html create mode 100644 docs/reference/index.html create mode 100644 docs/sitemap.xml diff --git a/.gitignore b/.gitignore index 0dddc4b..2743be2 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,3 @@ vignettes/*.pdf # R Environment Variables .Renviron inst/doc -docs diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..794dfbf --- /dev/null +++ b/docs/404.html @@ -0,0 +1,99 @@ + + + + + + + +Page not found (404) • DevelExample + + + + + + + + + + + +
+
+ + + + +
+
+
+

Page not found (404)

+
+ +Content not found. Please use links in the navbar. + +
+ + + +
+ + + +
+

+

Developed by Joshua Campbell.

+
+ +
+

+

Site built with pkgdown 2.0.3.

+
+ +
+
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 0000000..4732112 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,95 @@ + +License • DevelExample + + +
+
+ + + +
+
+
+

License

+
+ +
MIT License
+
+Copyright (c) 2022 campbio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+ +
+ + + +
+ + + +
+

Developed by Joshua Campbell.

+
+ +
+

Site built with pkgdown 2.0.3.

+
+ +
+ + + + + + + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html new file mode 100644 index 0000000..b60e81a --- /dev/null +++ b/docs/LICENSE.html @@ -0,0 +1,79 @@ + +MIT License • DevelExample + + +
+
+ + + +
+
+
+

MIT License

+
+ +
+

Copyright (c) 2022 DevelExample authors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+ +
+ + + +
+ + + +
+

Developed by Joshua Campbell.

+
+ +
+

Site built with pkgdown 2.0.3.

+
+ +
+ + + + + + + + diff --git a/docs/articles/DevelExample.html b/docs/articles/DevelExample.html new file mode 100644 index 0000000..d3ce655 --- /dev/null +++ b/docs/articles/DevelExample.html @@ -0,0 +1,154 @@ + + + + + + + +R Development Example • DevelExample + + + + + + + + + + + + +
+
+ + + + +
+
+
+

R Development Example

+ + + + + +
+ + + +

This is a simple vignette to demonstrate the functions that are available in the DevelExample package. The purpose of this package is to demonstrate the process of adding code to an R function. The full tutorial “Adding code to an R package” can be found at the Campbell lab website under the “Articles” tab.

+

Let’s first load the library:

+
+library(DevelExample)
+

Next we can run our function with default parameters:

+
+hello()
+#> [1] "Hello world!!!"
+

We can also run the same function but without all of the exclamation marks:

+
+hello(withExcitement = FALSE)
+#> [1] "Hello world."
+

To calculate the euclidean distance between two vectors, we can use the euclideanDist function. In this example we will generate two random vectors from normal distributions with two different means and calculate the distance between them:

+
+set.seed(12345)
+v1 <- rnorm(10000, mean = 1)
+v2 <- rnorm(10000, mean = 2)
+res <- euclideanDist(v1, v2, verbose = FALSE)
+res
+#> [1] 171.4371
+

The set.seed function is used for the random number generator and ensures the same vectors will be produced each time for reproducibility.

+

It is usually a good idea to show the session information to help with reproducibility:

+
+sessionInfo()
+#> R version 4.0.2 (2020-06-22)
+#> Platform: x86_64-apple-darwin17.0 (64-bit)
+#> Running under: macOS  10.16
+#> 
+#> Matrix products: default
+#> BLAS:   /Library/Frameworks/R.framework/Versions/4.0/Resources/lib/libRblas.dylib
+#> LAPACK: /Library/Frameworks/R.framework/Versions/4.0/Resources/lib/libRlapack.dylib
+#> 
+#> locale:
+#> [1] en_US.UTF-8/en_US.UTF-8/en_US.UTF-8/C/en_US.UTF-8/en_US.UTF-8
+#> 
+#> attached base packages:
+#> [1] stats     graphics  grDevices utils     datasets  methods   base     
+#> 
+#> other attached packages:
+#> [1] DevelExample_0.1.0
+#> 
+#> loaded via a namespace (and not attached):
+#>  [1] rstudioapi_0.13   knitr_1.39        magrittr_2.0.1    R6_2.5.0         
+#>  [5] ragg_1.1.3        rlang_1.0.2       fastmap_1.1.0     stringr_1.4.0    
+#>  [9] tools_4.0.2       xfun_0.30         cli_3.3.0         jquerylib_0.1.3  
+#> [13] htmltools_0.5.2   systemfonts_1.0.1 yaml_2.2.1        digest_0.6.27    
+#> [17] rprojroot_2.0.2   pkgdown_2.0.3     crayon_1.4.1      textshaping_0.3.5
+#> [21] purrr_0.3.4       sass_0.4.1        fs_1.5.0          memoise_2.0.0    
+#> [25] cachem_1.0.4      evaluate_0.15     rmarkdown_2.14    stringi_1.5.3    
+#> [29] compiler_4.0.2    bslib_0.3.1       desc_1.3.0        jsonlite_1.7.2
+
+ + + +
+ + + +
+

+

Developed by Joshua Campbell.

+
+ +
+

+

Site built with pkgdown 2.0.3.

+
+ +
+
+ + + + + + + + diff --git a/docs/articles/index.html b/docs/articles/index.html new file mode 100644 index 0000000..3905764 --- /dev/null +++ b/docs/articles/index.html @@ -0,0 +1,73 @@ + +Articles • DevelExample + + +
+
+ + + +
+
+
+

Articles

+
+ +
+

All vignettes

+

+ +
R Development Example
+
+
+
+
+ + +
+

Developed by Joshua Campbell.

+
+ +
+

Site built with pkgdown 2.0.3.

+
+ +
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..61c8a23 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,94 @@ + +Authors and Citation • DevelExample + + +
+
+ + + +
+
+
+
+

Authors

+
+ + +
  • +

    Joshua Campbell. Author, maintainer. +

    +
    • +
+
+
+

Citation

+ +
+
+ + +

Campbell J (2022). +DevelExample: A Basic R Package to Demonstrate a Cycle of Code Development. +R package version 0.1.0. +

+ 
@Manual{,
+  title = {DevelExample: A Basic R Package to Demonstrate a Cycle of Code Development},
+  author = {Joshua Campbell},
+  year = {2022},
+  note = {R package version 0.1.0},
+}
+ +
+ +
+ + + +
+

Developed by Joshua Campbell.

+
+ +
+

Site built with pkgdown 2.0.3.

+
+ +
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/docs/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/docs/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $('
    '); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/docs/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/docs/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..379e1d7 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,132 @@ + + + + + + + +A Basic R Package to Demonstrate a Cycle of Code Development • DevelExample + + + + + + + + + + + + +
    +
    + + + + +
    +
    + + +
    +

    DevelExample +

    +

    A basic R package to demonstrate a cycle of code development

    +

    For use with the coding tutorial “Adding code to an R package” which can be found at camplab.net under the “Articles” tab.

    +
    + +
    + + +
    + + +
    +

    +

    Developed by Joshua Campbell.

    +
    + +
    +

    +

    Site built with pkgdown 2.0.3.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/news/index.html b/docs/news/index.html new file mode 100644 index 0000000..144e6e2 --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,82 @@ + +Changelog • DevelExample + + +
    +
    + + + +
    +
    +
    +

    Changelog

    + +
    + +
    +

    Changes in Version 0.1.0 (2022-05-20)

    +
    • Added function to calculate euclidean distance
    +
    +

    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.
      • +
    +
    + + + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..80ea5b8 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,384 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.error {font-weight: bolder;} +.warning {font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..6f0eee4 --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,108 @@ +/* http://gregfranko.com/blog/jquery-best-practices/ */ +(function($) { + $(function() { + + $('.navbar-fixed-top').headroom(); + + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); + }); + + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } + } + + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $("div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 0000000..de87fcb --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,7 @@ +pandoc: 2.11.4 +pkgdown: 2.0.3 +pkgdown_sha: ~ +articles: + DevelExample: DevelExample.html +last_built: 2022-05-20T13:37Z + diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png new file mode 100644 index 0000000000000000000000000000000000000000..17a358060aed2a86950757bbd25c6f92c08c458f GIT binary patch literal 1011 zcmeAS@N?(olHy`uVBq!ia0y~yV0-|=9Be?5+AI5}0x7m6Z+90U4Fo@(ch>_c&H|6f zVg?3oArNM~bhqvg0|WD9PZ!6KiaBo&GBN^{G%5UFpXcEKVvd5*5Eu=C0SJK)8A6*F U7`aXvEC5;V>FVdQ&MBb@00SN#Z2$lO literal 0 HcmV?d00001 diff --git a/docs/reference/dot-checkData.html b/docs/reference/dot-checkData.html new file mode 100644 index 0000000..42a8978 --- /dev/null +++ b/docs/reference/dot-checkData.html @@ -0,0 +1,89 @@ + +Validity check — .checkData • DevelExample + + +
    +
    + + + +
    +
    +
    +

    Validity check

    + + +
    + +
    +

    This functions checks for NAs in a vector

    +
    + +
    + 
    .checkData(input)
    +
    + +
    +

    Arguments

    +
    input
    +

    A numeric vector

    +
    +
    +

    Value

    +

    Nothing returned

    +
    + +
    + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/euclideanDist.html b/docs/reference/euclideanDist.html new file mode 100644 index 0000000..5c5ef70 --- /dev/null +++ b/docs/reference/euclideanDist.html @@ -0,0 +1,103 @@ + +Euclidean distance — euclideanDist • DevelExample + + +
    +
    + + + +
    +
    +
    +

    Euclidean distance

    + + +
    + +
    +

    Calculates Euclidean distance between two vectors. An error +will be given if NAs are present in either vector.

    +
    + +
    + 
    euclideanDist(a, b, verbose = FALSE)
    +
    + +
    +

    Arguments

    +
    a
    +

    The first vector to use in the distance calculation.

    +
    b
    +

    The second vector to use in the distance calculation.

    +
    verbose
    +

    Boolean. If TRUE, a message will be printed. +Default TRUE.

    +
    +
    +

    Value

    +

    A numeric value of a distance

    +
    + +
    +

    Examples

    + 
    data(example_data)
+euclideanDist(example_data[,1], example_data[,2], verbose = FALSE)
+#> [1] 13.69805
+
    +
    +
    + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/example_data.html b/docs/reference/example_data.html new file mode 100644 index 0000000..07a79fd --- /dev/null +++ b/docs/reference/example_data.html @@ -0,0 +1,91 @@ + +Example dataset — example_data • DevelExample + + +
    +
    + + + +
    +
    +
    +

    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.

    +
    + +
    + 
    data("example_data")
    +
    + +
    +

    Format

    +

    A matrix with 100 rows and 2 columns

    +
    + +
    +

    Examples

    + 
    data("example_data")
+
    +
    +
    + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/hello.html b/docs/reference/hello.html new file mode 100644 index 0000000..8a571fe --- /dev/null +++ b/docs/reference/hello.html @@ -0,0 +1,96 @@ + +Hello world — hello • DevelExample + + +
    +
    + + + +
    +
    +
    +

    Hello world

    + + +
    + +
    +

    A simple function to print Hello world

    +
    + +
    + 
    hello(withExcitement = TRUE)
    +
    + +
    +

    Arguments

    +
    withExcitement
    +

    Boolean. If TRUE, then the message +will be printed with exlamation points. Default TRUE.

    +
    +
    +

    Value

    +

    A string with the hello world text

    +
    + +
    +

    Examples

    + 
    hello(withExcitement = TRUE)
+#> [1] "Hello world!!!"
+
    +
    +
    + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..b8bbf27 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,90 @@ + +Function reference • DevelExample + + +
    +
    + + + +
    +
    +
    +

    Reference

    +
    + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    .checkData()

    +

    Validity check

    +

    euclideanDist()

    +

    Euclidean distance

    +

    example_data

    +

    Example dataset

    +

    hello()

    +

    Hello world

    + + +
    + + +
    +

    Developed by Joshua Campbell.

    +
    + +
    +

    Site built with pkgdown 2.0.3.

    +
    + +
    + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..20905ab --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,42 @@ + + + + /404.html + + + /LICENSE-text.html + + + /LICENSE.html + + + /articles/DevelExample.html + + + /articles/index.html + + + /authors.html + + + /index.html + + + /news/index.html + + + /reference/dot-checkData.html + + + /reference/euclideanDist.html + + + /reference/example_data.html + + + /reference/hello.html + + + /reference/index.html + +