more devtools checking

tonyelhabr · Jan 21, 2024 · c37466c · c37466c
1 parent 542602a
commit c37466c
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 12 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -18,6 +18,7 @@ Imports:
     rlang (>= 0.4.11),
     scales (>= 1.1.0)
 Suggests: 
+    purrr (>= 0.2.0),
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Encoding: UTF-8

diff --git a/R/geom_soccer_logos.R b/R/geom_soccer_logos.R
@@ -40,9 +40,9 @@
 #' team_names <- soccerplotR::valid_team_names("ENG")
 #'
 #' df <- data.frame(
-#'   a = rep(1:6, 8),
-#'   b = sort(rep(1:8, 6), decreasing = TRUE),
-#'   team_name = c(team_names, rep(NA, 3))
+#'   a = c(rep(1:6, 7), c(1, 2)),
+#'   b = sort(c(rep(1:7, 6), c(8, 8)), decreasing = TRUE),
+#'   team_name = team_names
 #' )
 #'
 #' # keep alpha == 1 for all teams including an 'A'

diff --git a/R/sysdata.rda b/R/sysdata.rda
diff --git a/R/utils.R b/R/utils.R
@@ -44,10 +44,19 @@ all_valid_team_names <- function() {
 #'   Non matches may be replaced with `NA` (depending on the value of `keep_non_matches`).
 #' @export
 #' @examples
-#' team_names <- c('Liverpool', 'Brighton', 'Bournemouth', 'AFC Bournemouth')
+#' \donttest{
+#' team_names <- c('Bournemouth', 'AFC Bournemouth', 'Bournemouth AFC')
 #'
 #' # keep non matches
-#' soccerplotR::clean_team_names(team_names, keep_non_matches = TRUE)
+#' soccerplotR::clean_team_names(team_names)
+#'
+#' # drop "bad" names
+#' soccerplotR::clean_team_names(team_names, keep_non_matches = FALSE)
+#'
+#' # silence warnings
+#' # options(soccerplotR.verbose = FALSE)
+#' soccerplotR::clean_team_names(team_names)
+#' }
 clean_team_names <- function(
     team_name,
     keep_non_matches = TRUE

diff --git a/data-raw/build_internal_data.R b/data-raw/build_internal_data.R
@@ -223,7 +223,7 @@ team_name_mapping[['ENG']] <- c(
     'Swansea City' = 'Swansea',
     'West Bromwich Albion' = 'West Brom',
     'West Ham United' = 'West Ham',
-    'Wigan Athletic' = 'Wigan',
+    # 'Wigan Athletic' = 'Wigan',
     'Wolverhampton Wanderers' = 'Wolves',
     ## Opta
     'WBA' = 'West Brom'

diff --git a/data/team_name_mapping.rda b/data/team_name_mapping.rda
diff --git a/man/clean_team_names.Rd b/man/clean_team_names.Rd
diff --git a/man/geom_soccer_logos.Rd b/man/geom_soccer_logos.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -68,6 +68,7 @@ reference:
   desc: >
     Various helper functions.
   contents:
-  - clean_team_abbrs
+  - clean_team_names
+  - all_valid_team_names
   - valid_team_names
   - team_name_mapping