all examples to \dontrun

FlavioLeccese92 · Feb 21, 2024 · 4d0402a · 4d0402a
1 parent b4d8cb7
commit 4d0402a
Show file tree

Hide file tree

Showing 36 changed files with 205 additions and 14 deletions.
diff --git a/R/get-competition-aheadbehind.R b/R/get-competition-aheadbehind.R
@@ -10,8 +10,13 @@
 #'
 #' Reference webpage: [Ahead-behind standings](<https://www.euroleaguebasketball.net/euroleague/standings/?season=2023-24&type=Ahead%20behind&phase=REGULAR%20SEASON>)
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getCompetitionAheadBehind(season_code = c("E2023", "E2022"), round = 1)
 #'
+#' }
+#'
 #' @name getCompetitionAheadBehind
 #' @rdname getCompetitionAheadBehind
 #' @export

diff --git a/R/get-competition-calendar.R b/R/get-competition-calendar.R
@@ -10,9 +10,15 @@
 #' and rounds
 #'
 #' Reference webpage: [Calendar standings](<https://www.euroleaguebasketball.net/euroleague/standings/?season=2023-24&type=Calendar&phase=REGULAR%20SEASON>)
+#'
 #' @examples
+#'
+#' if(interactive()) {
+#'
 #' getCompetitionCalendar(season_code = c("E2023", "E2022"), round = 1)
 #'
+#' }
+#'
 #' @name getCompetitionCalendar
 #' @rdname getCompetitionCalendar
 #' @export

diff --git a/R/get-competition-margins.R b/R/get-competition-margins.R
@@ -9,9 +9,15 @@
 #' @return Returns a summary tibble of standing margins for chosen competition and round
 #'
 #' Reference webpage: [Margins standings](<https://www.euroleaguebasketball.net/euroleague/standings/?season=2023-24&type=Margins&phase=REGULAR%20SEASON>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getCompetitionMargins(season_code = c("E2023", "E2022"), round = 1)
 #'
+#' }
+#'
 #' @name getCompetitionMargins
 #' @rdname getCompetitionMargins
 #' @export

diff --git a/R/get-competition-metadata.R b/R/get-competition-metadata.R
@@ -13,6 +13,9 @@
 #' @inheritParams .inheritParams
 #'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getCompetitionHistory(competition_code = c("E", "U")) |> head(5)
 #'
 #' getCompetitionRounds(season_code = c("E2023", "E2022")) |> head(5)
@@ -22,6 +25,8 @@
 #' getCompetitionTeams(season_code = c("E2023", "U2023")) |> head(5)
 #'
 #' getCompetitionGames(season_code = "E2023", round = 1:5) |> head(5)
+#'
+#' }
 
 #' @rdname getCompetitionMetadata
 #' @export

diff --git a/R/get-competition-standings.R b/R/get-competition-standings.R
@@ -9,9 +9,15 @@
 #' @return Returns a summary tibble of standings for chosen competitions and rounds
 #'
 #' Reference webpage: [Traditional standings](<https://www.euroleaguebasketball.net/euroleague/standings/?season=2023-24&type=Traditional&phase=REGULAR%20SEASON>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getCompetitionStandings(season_code = c("E2023", "E2022"), round = 1)
 #'
+#' }
+#'
 #' @name getCompetitionStandings
 #' @rdname getCompetitionStandings
 #' @export

diff --git a/R/get-competition-streaks.R b/R/get-competition-streaks.R
@@ -9,9 +9,15 @@
 #' @return Returns a summary tibble of streaks for chosen competitions and rounds
 #'
 #' Reference webpage: [Streaks standings](<https://www.euroleaguebasketball.net/euroleague/standings/?season=2023-24&type=Streaks&phase=REGULAR%20SEASON>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getCompetitionStreaks(season_code = c("E2023", "E2022"), round = 1)
 #'
+#' }
+#'
 #' @name getCompetitionStreaks
 #' @rdname getCompetitionStreaks
 #' @export

diff --git a/R/get-game-box-score.R b/R/get-game-box-score.R
@@ -42,9 +42,15 @@
 #' | PIR             | Performance Index Rating  |
 #'
 #' Reference webpage: [BoxScore](<https://www.euroleaguebasketball.net/euroleague/game-center/2023-24/crvena-zvezda-meridianbet-belgrade-ldlc-asvel-villeurbanne/E2023/1/#boxscore>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getGameBoxScore(season_code = c("E2023", "U2023"), game_code = 1)
 #'
+#' }
+#'
 #' @name getGameBoxScore
 #' @rdname getGameBoxScore
 #' @export

diff --git a/R/get-game-evolution.R b/R/get-game-evolution.R
@@ -10,9 +10,15 @@
 #' - **Evolution**. Minute by minute points of each team
 #'
 #' Reference webpage: [GraphicStats](<https://www.euroleaguebasketball.net/euroleague/game-center/2023-24/crvena-zvezda-meridianbet-belgrade-ldlc-asvel-villeurbanne/E2023/1/#graphic-stats>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getGameEvolution(season_code = c("E2023", "U2023"), game_code = 1)
 #'
+#' }
+#'
 #' @name getGameEvolution
 #' @rdname getGameEvolution
 #' @export

diff --git a/R/get-game-metadata.R b/R/get-game-metadata.R
@@ -14,11 +14,16 @@
 #' @inheritParams .inheritParams
 #'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getGameHeader(season_code = c("E2023", "U2023"), game_code = 1)
 #'
 #' getGamePlayers(season_code = c("E2023", "U2023"), team_code = "ASV", game_code = 1)
 #'
 #' getGameRound(season_code = c("E2023", "U2023"), game_code = 1)
+#'
+#' }
 
 
 #' @rdname getGameMetadata

diff --git a/R/get-game-playbyplay.R b/R/get-game-playbyplay.R
@@ -42,13 +42,19 @@
 #' | TOUT_TV      | TV Time Out               |
 #'
 #' Reference webpage: [PlayByPlay](<https://www.euroleaguebasketball.net/euroleague/game-center/2023-24/crvena-zvezda-meridianbet-belgrade-ldlc-asvel-villeurbanne/E2023/1/#play-by-play>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' PlayByPlay = getGamePlayByPlay(season_code = c("E2023", "U2023"), game_code = 1)
 #'
 #' PlayByPlay$PlayByPlaySummary |> head(5)
 #'
 #' PlayByPlay$PlayByPlay |> head(5)
 #'
+#' }
+#'
 #' @name getGamePlayByPlay
 #' @rdname getGamePlayByPlay
 #' @export

diff --git a/R/get-game-points.R b/R/get-game-points.R
@@ -13,9 +13,15 @@
 #' - **Zone**. Area of the court of the shot
 #'
 #' Reference webpage: [PlayByPlay](<https://www.euroleaguebasketball.net/euroleague/game-center/2023-24/crvena-zvezda-meridianbet-belgrade-ldlc-asvel-villeurbanne/E2023/1/#play-by-play>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getGamePoints(season_code = c("E2023", "U2023"), game_code = 1)
 #'
+#' }
+#'
 #' @name getGamePoints
 #' @rdname getGamePoints
 #' @export

diff --git a/R/get-player-advanced.R b/R/get-player-advanced.R
@@ -23,9 +23,15 @@
 #' | FT-RT           | Free Throw rate           | Measure of free throw attempts vs. field goal attempts                |
 #'
 #' Reference webpage: [Stats](<https://www.euroleaguebasketball.net/euroleague/stats/expanded/?size=1000&viewType=advanced&seasonCode=E2023&statisticMode=perGame&seasonMode=Single&sortDirection=descending&statistic=blocksFavour>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getPlayerAdvanced(season_code = "E2023", statistic_mode = "perGame")
 #'
+#' }
+#'
 #' @name getPlayerAdvanced
 #' @rdname getPlayerAdvanced
 #' @export

diff --git a/R/get-player-misc.R b/R/get-player-misc.R
@@ -14,9 +14,15 @@
 #' | TD3             | Triple-doubles           | Games with double-digit totals in three of: points, rebounds, assists, steals and blocks|
 #'
 #' Reference webpage: [Stats](<https://www.euroleaguebasketball.net/euroleague/stats/expanded/?size=1000&viewType=miscellaneous&seasonCode=E2023&statisticMode=accumulated&seasonMode=Single&sortDirection=descending&statistic=gamesPlayed>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getPlayerMisc(season_code = "E2023")
 #'
+#' }
+#'
 #' @name getPlayerMisc
 #' @rdname getPlayerMisc
 #' @export

diff --git a/R/get-player-points.R b/R/get-player-points.R
@@ -23,9 +23,15 @@
 #' | %FT             | % of points from free throws    | % of points from free throws made                         |
 #'
 #' Reference webpage: [Stats](<https://www.euroleaguebasketball.net/euroleague/stats/expanded/?size=1000&viewType=scoring&seasonCode=E2023&statisticMode=perGame&seasonMode=Single&sortDirection=descending&statistic=fieldGoals2Percent>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getPlayerPoints(season_code = "E2023")
 #'
+#' }
+#'
 #' @name getPlayerPoints
 #' @rdname getPlayerPoints
 #' @export

diff --git a/R/get-player-stats.R b/R/get-player-stats.R
@@ -36,9 +36,15 @@
 #' | PIR             | Performance Index Rating  |
 #'
 #' Reference webpage: [Stats](<https://www.euroleaguebasketball.net/euroleague/stats/expanded/?size=1000&viewType=traditional&seasonCode=E2023&statisticMode=perGame&seasonMode=Single&sortDirection=descending&statistic=blocksFavour>)
+#'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getPlayerStats(season_code = "E2023", statistic_mode = "perGame")
 #'
+#' }
+#'
 #' @name getPlayerStats
 #' @rdname getPlayerStats
 #' @export

diff --git a/R/get-team-lead-stats.R b/R/get-team-lead-stats.R
@@ -38,14 +38,19 @@
 #' | PIR             | Performance Index Rating  |
 #'
 #' Reference webpage: [TeamLead](<https://www.euroleaguebasketball.net/euroleague/stats/key-stats-teams/?size=200&misc=HomeGames&seasonCode=E2023&category=FreeThrowsAttempted&seasonMode=Single&sortDirection=descending&aggregate=accumulated>)
+#'
 #' @examples
-#' if (FALSE) {
+#'
+#' \dontrun{
+#'
 #'   TeamLeadStats = getTeamLeadStats(season_code = c("E2022", "E2023"), phase_type = "RS")
 #'
 #'   TeamLeadStats$TeamAccumulated |> head(5)
 #'
 #'   TeamLeadStats$TeamAveragePerGame |> head(5)
+#'
 #' }
+#'
 #' @name getTeamLeadStats
 #' @rdname getTeamLeadStats
 #' @export

diff --git a/R/get-team-metadata.R b/R/get-team-metadata.R
@@ -14,11 +14,16 @@
 #' @inheritParams .inheritParams
 #'
 #' @examples
+#'
+#' \dontrun{
+#'
 #' getTeam(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
 #'
 #' getTeamPeople(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
 #'
 #' getTeamGames(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
+#'
+#' }
 
 
 #' @rdname getTeamMetadata

diff --git a/R/get-team-stats.R b/R/get-team-stats.R
@@ -43,17 +43,22 @@
 #' Reference webpage: [Team](<https://www.euroleaguebasketball.net/euroleague/teams/ldlc-asvel-villeurbanne/statistics/asv/?season=2023-24&phase=All%20phases>)
 #'
 #' @examples
-#' TeamStats = getTeamStats(team_code = "ASV", season_code = c("E2023", "E2022"), phase_type = "RS")
 #'
-#' TeamStats$PlayerAccumulated |> head(5)
+#' \dontrun{
 #'
-#' TeamStats$PlayerAveragePerGame |> head(5)
+#'   TeamStats = getTeamStats(team_code = "ASV", season_code = c("E2023", "E2022"), phase_type = "RS")
 #'
-#' TeamStats$PlayerAveragePer40 |> head(5)
+#'   TeamStats$PlayerAccumulated |> head(5)
 #'
-#' TeamStats$TeamAccumulated |> head(5)
+#'   TeamStats$PlayerAveragePerGame |> head(5)
 #'
-#' TeamStats$TeamAveragePerGame |> head(5)
+#'   TeamStats$PlayerAveragePer40 |> head(5)
+#'
+#'   TeamStats$TeamAccumulated |> head(5)
+#'
+#'   TeamStats$TeamAveragePerGame |> head(5)
+#'
+#' }
 #'
 #' @name getTeamStats
 #' @rdname getTeamStats

diff --git a/man/getCompetitionAheadBehind.Rd b/man/getCompetitionAheadBehind.Rd
diff --git a/man/getCompetitionCalendar.Rd b/man/getCompetitionCalendar.Rd
diff --git a/man/getCompetitionMargins.Rd b/man/getCompetitionMargins.Rd
diff --git a/man/getCompetitionMetadata.Rd b/man/getCompetitionMetadata.Rd
diff --git a/man/getCompetitionStandings.Rd b/man/getCompetitionStandings.Rd