version 1.0.3

cran · May 4, 2023 · 776c0fe · 776c0fe
1 parent 36a4685
commit 776c0fe
Show file tree

Hide file tree

Showing 256 changed files with 1,898 additions and 772 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: iemisc
 Title: Irucka Embry's Miscellaneous Functions
-Version: 1.0.2
+Version: 1.0.3
 Authors@R: c(person("Irucka", "Embry", role = c("aut", "cre"), email = "[email protected]"),
     person("Felix", "Andrews", role = c("aut", "ctb"), comment = "zoo code"),
     person("Hans Werner", "Borchers", role = c("aut", "ctb"), comment = "pracma code"),
@@ -9,6 +9,7 @@ Authors@R: c(person("Irucka", "Embry", role = c("aut", "cre"), email = "iembry@e
     person("Rik", "Wehbring", role = c("aut", "ctb"), comment = "GNU Octave code"),
     person("Didier", "Clamond", role = c("aut", "ctb"), comment = "MATLAB code"),
     person("Berry", "Boessenkool", role = c("aut", "ctb"), comment = "checkLL and degree functions from OSMscale"),
+    person("Tyler", "Rinker", role = c("aut", "ctb"), comment = "lookup and lookup_helper functions from qdapTools"),
     person("Colin", "Caprani", role = c("aut", "ctb"), comment = "secprop MATLAB function"),
     person("Teodor", "Ciuraru", role = c("aut", "ctb"), comment = "stackoverflow R code"),
     person("Dylan", "Russell", role = c("aut", "ctb"), comment = "stackoverflow R code"),
@@ -20,11 +21,11 @@ Maintainer: Irucka Embry <[email protected]>
 Depends: R (>= 3.3.0)
 Imports: zoo, pracma, iemiscdata, gsubfn (>= 0.7), fpCompare, units (>=
         0.7-0), CHNOSZ (>= 1.3.3), stringi, assertthat, rivr (>=
-        1.2-2), checkmate, qdapTools, ramify, foreach, stats,
-        data.table (>= 1.10.2), measurements, roperators,
-        berryFunctions, round, USA.state.boundaries (>= 1.0.1), sf,
-        ggplot2, ggpubr, matlab, sjmisc, lubridate, anytime, qdapRegex,
-        mgsub, geosphere, matlab2r, signal, utils, methods
+        1.2-2), checkmate, ramify, foreach, stats, data.table (>=
+        1.10.2), measurements, roperators, berryFunctions, round,
+        USA.state.boundaries (>= 1.0.1), sf, ggplot2, ggpubr, matlab,
+        sjmisc, lubridate, anytime, qdapRegex, mgsub, geosphere,
+        matlab2r, signal, utils, methods
 Suggests: install.load, knitr, import, fractional, fracture, MASS,
         rmarkdown, tinytest, maps, spelling, sampler, callr, rando,
         geometry, linguisticsdown, aiRthermo, hydraulics, ie2misc,
@@ -42,7 +43,7 @@ Encoding: UTF-8
 VignetteBuilder: knitr
 RoxygenNote: 7.2.3
 NeedsCompilation: no
-Packaged: 2023-03-03 20:44:55 UTC; xbyri
+Packaged: 2023-05-03 02:33:21 UTC; xbyri
 Author: Irucka Embry [aut, cre],
   Felix Andrews [aut, ctb] (zoo code),
   Hans Werner Borchers [aut, ctb] (pracma code),
@@ -52,6 +53,8 @@ Author: Irucka Embry [aut, cre],
   Didier Clamond [aut, ctb] (MATLAB code),
   Berry Boessenkool [aut, ctb] (checkLL and degree functions from
     OSMscale),
+  Tyler Rinker [aut, ctb] (lookup and lookup_helper functions from
+    qdapTools),
   Colin Caprani [aut, ctb] (secprop MATLAB function),
   Teodor Ciuraru [aut, ctb] (stackoverflow R code),
   Dylan Russell [aut, ctb] (stackoverflow R code),
@@ -60,4 +63,4 @@ Author: Irucka Embry [aut, cre],
   Josh O'Brien [aut, ctb] (stackoverflow R code),
   R. van Twisk [aut, ctb] (LibreCAD code)
 Repository: CRAN
-Date/Publication: 2023-03-07 08:00:06 UTC
+Date/Publication: 2023-05-04 08:30:02 UTC
diff --git a/LICENSE b/LICENSE
diff --git a/MD5 b/MD5
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export("%//%")
+export("%notchin%")
 export("%qsin%")
 export(AF)
 export(AP)
@@ -88,6 +89,7 @@ export(kin_visc_water)
 export(lat_long2state)
 export(lat_long2utm)
 export(length_octave)
+export(lookupQT)
 export(maxmre)
 export(mortality_rate)
 export(mortality_rate_pct)
@@ -105,6 +107,7 @@ export(polygon_area)
 export(project_midpoint)
 export(prop_mortality_ratio)
 export(prop_solver)
+export(rain_garden_driveway)
 export(ranges)
 export(rational_formula)
 export(reduce_single_digit)
@@ -125,6 +128,7 @@ export(sp_volume)
 export(splitcomma)
 export(splitremove)
 export(surf_tens_water)
+export(surface_area)
 export(tand)
 export(unit_wt)
 export(volsphere)
@@ -134,6 +138,7 @@ import(CHNOSZ)
 import(USA.state.boundaries)
 import(iemiscdata)
 importFrom(anytime,anydate)
+importFrom(anytime,anytime)
 importFrom(assertthat,assert_that)
 importFrom(assertthat,is.scalar)
 importFrom(berryFunctions,getColumn)
@@ -145,6 +150,7 @@ importFrom(checkmate,testDataTable)
 importFrom(checkmate,testString)
 importFrom(checkmate,test_data_frame)
 importFrom(data.table,"%chin%")
+importFrom(data.table,"%like%")
 importFrom(data.table,":=")
 importFrom(data.table,.EACHI)
 importFrom(data.table,.I)
@@ -189,7 +195,6 @@ importFrom(pracma,newtonRaphson)
 importFrom(pracma,nthroot)
 importFrom(pracma,zeros)
 importFrom(qdapRegex,rm_white)
-importFrom(qdapTools,lookup)
 importFrom(ramify,mat)
 importFrom(rivr,critical_depth)
 importFrom(roperators,"%+%")
@@ -204,6 +209,7 @@ importFrom(stats,approx)
 importFrom(stats,na.omit)
 importFrom(stats,sd)
 importFrom(stats,uniroot)
+importFrom(stringi,stri_count_fixed)
 importFrom(stringi,stri_count_regex)
 importFrom(stringi,stri_detect_fixed)
 importFrom(stringi,stri_detect_regex)

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,16 @@
+# iemisc 1.0.3 (3 May 2023)
+
+* Modified the Help section and the package introduction on the README
+* Revised the non-standard evaluation of library calls to standard evaulation calls in the README and in all functions
+* Revised some grammatical issues in various functions
+* Revised the splitcomma function to allow for a set of names in a single character vector to be separated by " & "
+* Revised the reduce_single_digit function to allow for date times and vectors with decimals
+* Revised all of the vignettes -- removed the PNG image for the Creative Commons license due to it failing consistently on certain OSes. Also added the EcoC²S services link to all of the vignettes as well.
+* Added the notchin function (Negate chin from `data.table` and Negate in from `base` R) to determine which character or numeric vectors are not in a set of character or numeric vectors
+* Added the surface_area (for calculating the linear surface area) & rain_garden_driveway (for sizing a rain garden based on driveway surface areas) functions
+* Removed `qdapTools` from Imports as Prof Brian Ripley sent an e-mail that `qdapTools` is scheduled for archival on 6 May 2023 due to failing the CRAN checks. The lookupQT (lookup in `qdapTools`) and lookup_helperQT (lookup_helper in `qdapTools`) functions have been added to the package to avoid `iemisc` from being archived on that date too. The existing functions have been modified to use lookupQT instead of lookup.
+
+
 # iemisc 1.0.2 (4 March 2023)
 
 * CRAN update to move from archived back to active state

diff --git a/R/AgivenF.R b/R/AgivenF.R
@@ -49,7 +49,7 @@
 #'
 #' @examples
 #'
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-12 from the Reference text (page 135-136)
 #' AgivenF(309*10^6, 60, 0.5, "month")

diff --git a/R/AgivenFcont.R b/R/AgivenFcont.R
@@ -46,7 +46,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' AgivenFcont(300, 2, 11) # 11\% interest
 #'
@@ -129,7 +129,7 @@ return(round_r3(AgivenFcont, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' PgivenFcont(1000, 9, 7) # the interest rate is 7%
 #'
@@ -209,7 +209,7 @@ return(round_r3(PgivenFcont, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' PgivenAcont(2000, 3, 12) # the interest rate is 12%
 #'
@@ -288,7 +288,7 @@ return(round_r3(PgivenAcont, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-33 from the Reference text (page 170)
 #' FgivenPcont(10000, 2, 5) # the interest rate is 5%
@@ -369,7 +369,7 @@ return(round_r3(FgivenPcont, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' FgivenAcont(2100, 13, 7) # the interest rate is 7%
 #'
@@ -449,7 +449,7 @@ return(round_r3(FgivenAcont, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-34 from the Reference text (page 170)
 #' AgivenPcont(1000, 10, 20) # 20\% interest

diff --git a/R/AgivenP.R b/R/AgivenP.R
@@ -49,7 +49,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-14 from the Reference text (page 136)
 #' AgivenP(17000, 4, 1, "annual")

diff --git a/R/EffInt.R b/R/EffInt.R
@@ -50,7 +50,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-28 from Sullivan Reference text (page 165)
 #' EffInt(1.375, frequency = "month")

diff --git a/R/FgivenA.R b/R/FgivenA.R
@@ -49,7 +49,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-7 from the Reference text (page 131-132)
 #' FgivenA(23000, 40, 6, "annual") # the interest rate is 6\%

diff --git a/R/FgivenP.R b/R/FgivenP.R
@@ -47,7 +47,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-3 from the Reference text (page 124)
 #' FgivenP(8000, 4, 10, frequency = "annual") # the interest rate is 10\%

diff --git a/R/Manningcirc.R b/R/Manningcirc.R
diff --git a/R/Manningpara.R b/R/Manningpara.R
@@ -242,7 +242,7 @@
 #'
 #' @examples
 #'
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Exercise 4.3 from Sturm (page 153)
 #' y <- Manningpara(Q = 12.0, B1 = 10, y1 = 2.0, Sf = 0.005, n = 0.05, units = "SI")

diff --git a/R/Manningrect.R b/R/Manningrect.R
diff --git a/R/Manningtrap.R b/R/Manningtrap.R
@@ -386,7 +386,7 @@
 #' 
 #' # Example 1
 #'
-#' library("iemisc")
+#' library(iemisc)
 #' # Exercise 4.1 from Sturm (page 153)
 #'
 #' uu <- Manningtrap(Q = 3000, b = 40, m = 3, Sf = 0.002, n = 0.025,
@@ -1958,7 +1958,7 @@ result_table
 #' 
 #' # Example 1
 #'
-#' library("iemisc")
+#' library(iemisc)
 #' # Exercise 4.1 from Sturm (page 153)
 #'
 #' uuc <- Manningtrap_critical(Q = 3000, b = 40, m = 3, Sf = 0.002, n = 0.025,

diff --git a/R/Manningtri.R b/R/Manningtri.R
diff --git a/R/PgivenA.R b/R/PgivenA.R
@@ -60,7 +60,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 1 -- Example 4-9 from the Sullivan Reference text (page 133-134)
 #' PgivenA(A = 20000, n = 5, i = 15, frequency = "annual") # the interest rate is 15%

diff --git a/R/PgivenA1.R b/R/PgivenA1.R
@@ -52,7 +52,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-23 from the Reference text (page 158-159)
 #' PgivenA1(A1 = 1000, i = 25, f = 20, n = 4) # i is 25\% and f is 20\%

diff --git a/R/PgivenF.R b/R/PgivenF.R
@@ -48,7 +48,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-4 from the Reference text (page 128)
 #' PgivenF(10000, 6, 8, "annual") # the interest rate is 8%

diff --git a/R/PgivenFivary.R b/R/PgivenFivary.R
@@ -49,7 +49,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-31 from the Reference text (page 162)
 #' PgivenFivary(Fn = 1000, ik = c(10, 12, 13, 10), k = 1)

diff --git a/R/PgivenG.R b/R/PgivenG.R
@@ -43,7 +43,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-20 from the Reference text (pages 153-154)
 #' PgivenG(1000, 4, 15, "annual") # the interest rate is 15%
@@ -195,7 +195,7 @@ return(round_r3(PgivenG, d = 2))
 #'
 #' @examples
 ##' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example 4-20 from the Reference text (pages 153-154)
 #'   AgivenG(1000, 4, 15, "annual") # the interest rate is 15\%

diff --git a/R/Re.R b/R/Re.R
@@ -214,7 +214,7 @@
 #' 
 #' # from the Chow reference, water at 68 F (20 C) has the following properties
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # mu (dynamic viscosity) = 2.09 * 10 ^ -5 slug/ft-sec
 #' # rho (density) = 1.937 slug/ft^3
@@ -318,7 +318,7 @@ return(list(nu = nu, Re1 = Re1))
 #' # and
 #' # Re = 1.8 * 10 ^ 5
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' Re2(D = 0.3355, V = 7.56, nu = 1.41 * 10 ^ -5)
 #'
@@ -483,7 +483,7 @@ return(Re3)
 #' # nu = 2.40 * 10 ^ -5 ft^2/s
 #' # D = 9.03 * 10 ^ -2 ft
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' Re4(Q = 2.23 * 10 ^ -2, nu = 2.40 * 10 ^ -5, D = 9.03 * 10 ^ -2)
 #'

diff --git a/R/Rem.R b/R/Rem.R
@@ -29,7 +29,7 @@
 #' 
 #' # Example from GNU Octave
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #' 
 #' x <- 23.4
 #' y <- 20
@@ -107,7 +107,7 @@ assert_that(qtest(n, "N+[,]"), msg = "n is NA, NaN, empty, or a string. Please t
 #'
 #' # Example from FreeMat
 #'
-#' library("iemisc")
+#' library(iemisc)
 #' 
 #' Mod_octave(18, 12)
 #' 

diff --git a/R/SimpIntPaid.R b/R/SimpIntPaid.R
@@ -53,7 +53,7 @@
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-1 from the Sullivan Reference text (page 116)
 #' SimpIntPaid(1000, 3, 10) # the interest rate is 10%
@@ -145,7 +145,7 @@ return(round_r3(P * (1 + n * i), d = 2)) # total amount paid
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Compound Interest example from SFPE Reference text
 #' CompIntPaid(100, 5, 10, frequency = "annual") # the interest rate is 10%
@@ -308,7 +308,7 @@ return(round_r3(CompIntPaid, d = 2))
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Example for equation 4-1 from the Sullivan Reference text (page 116)
 #' # Modified example to provide the simple interest amount paid only
@@ -402,7 +402,7 @@ return(round_r3(I, d = 2)) # total interest paid (accumulated)
 #'
 #' @examples
 #' 
-#' library("iemisc")
+#' library(iemisc)
 #'
 #' # Compound Interest example from SFPE Reference text
 #' # Modified example to provide the compounded interest amount paid only