Minor documentation updates

R/summary_graph.R

@@ -25,10 +25,10 @@
 #'
 #' summary_graph(iris, "Petal.Length", "Species", "mm")
 #'
-#' # Multiple
+#' # Multiple explanatory variables can be provided as a vector
 #' summary_graph(npk, "yield", c("N", "P"), "lb/plot")
 #'
-#  # Three way interaction
+#  # Three way interaction of explanatory variables
 #' summary_graph(npk, "yield", c("N", "P", "K"), "lb/plot")
 #'
 summary_graph <- function(data, response, exp_var, resp_units = "") {

R/utility_functions.R

@@ -68,10 +68,9 @@ quiet <- function(x) {
 
 #' Function to compare package version for mocking
 #'
-#' @param a One package version
-#' @param b Another package version
+#' @param a,b Character strings representing package version numbers.
 #'
-#' @return
+#' @return Numeric. `0` if the numbers are equal, `-1` if `b` is later and `1` if `a` is later
 #' @keywords internal
 compare_version <- function(a, b) {
     return(utils::compareVersion(as.character(a), as.character(b)))

README.Rmd

@@ -40,7 +40,7 @@ The goal of biometryassist is to provide functions to aid in the Design and Anal
 
 ## Installation
 
-As of version 1.0.0 the biometryassist package is now [on CRAN](https://cran.r-project.org/package=biometryassist) `r emo::ji("raised_hands")`.
+As of version 1.0.0 the biometryassist package is now [on CRAN](https://cran.r-project.org/package=biometryassist) 🙌
 That means that installation is as easy as running:
 
 ```{r installing_cran, eval=FALSE}
@@ -50,7 +50,8 @@ install.packages("biometryassist")
 
 ### Development version
 
-`r emo::ji("warning")`**Warning**: The development version is unstable and liable to change more often than the CRAN version. It may have bugs fixed, but there may be other currently unknown bugs introduced. `r emo::ji("warning")`
+⚠ **Warning**: The development version is unstable and liable to change more often than the CRAN version. It may have bugs fixed, but there may be other currently unknown bugs introduced. ⚠
+
 
 Use the following code to install the latest development version of this package.
 

README.md

@@ -14,7 +14,7 @@ coverage](https://codecov.io/gh/biometryhub/biometryassist/branch/main/graph/bad
 status](https://github.com/biometryhub/biometryassist/workflows/R-CMD-check/badge.svg)](https://github.com/biometryhub/biometryassist/actions)
 [![minimal R
 version](https://img.shields.io/badge/R%3E%3D-4.0.0-6666ff.svg)](https://cran.r-project.org/)
-[![packageversion](https://img.shields.io/badge/Package%20version-1.1.3-orange.svg?style=flat-square)](https://github.com/biometryhub/biometryassist/commits/main)
+[![packageversion](https://img.shields.io/badge/Package%20version-1.2.1-orange.svg?style=flat-square)](https://github.com/biometryhub/biometryassist/commits/main)
 [![Licence](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)
 [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fbiometryhub%2Fbiometryassist&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
 <!-- badges: end -->
@@ -33,7 +33,7 @@ longer maintained, but can still be found at
 ## Installation
 
 As of version 1.0.0 the biometryassist package is now [on
-CRAN](https://cran.r-project.org/package=biometryassist) 🙌. That means
+CRAN](https://cran.r-project.org/package=biometryassist) 🙌 That means
 that installation is as easy as running:
 
 ``` r
@@ -42,9 +42,9 @@ install.packages("biometryassist")
 
 ### Development version
 
-⚠️**Warning**: The development version is unstable and liable to change
+⚠ **Warning**: The development version is unstable and liable to change
 more often than the CRAN version. It may have bugs fixed, but there may
-be other currently unknown bugs introduced. ⚠️
+be other currently unknown bugs introduced. ⚠
 
 Use the following code to install the latest development version of this
 package.