nbafuns: Functions for nba PCA analysis

#' NBA season 2018 players advanced statistics.
#'
#' A dataset containing the advanced statistics for each player
#' from the 2018 season. This is the raw dataset of our
#' project.
#'
#' @format A data frame with 664 rows and 30 variables
#' \describe{
#'   \item{rk}{rank, a number}
#'   \item{player}{player full name, firstname and last name}
#'   \item{pos}{position of the player, position on the field}
#'   \item{age}{age of the player, a number}
#'   \item{tm}{team, a name}
#'   \item{g}{games, number of games}
#'   \item{mp}{minutes played, in minutes}
#'   \item{per}{player efficiency rating, average is 15}
#'   \item{tspercent}{true shooting percentage, in percentage}
#'   \item{x3par}{percentage of fg attempts from 3P range, in percentage}
#'   \item{ftr}{free throw attempt rate, }
#'   \item{orbpercent}{offensive rebound percentage, in percents}
#'   \item{drbpercent}{defensive rebound percentage, in percents}
#'   \item{trbpercent}{total rebound percentage, in percents}
#'   \item{astpercent}{assist percentage, in percents}
#'   \item{stlpercent}{steal percentage, in percents}
#'   \item{blkpercent}{block percentage, in percents}
#'   \item{tovpercent}{turnover percentage, in percents}
#'   \item{usgpercent}{usage percentage, in percents}
#'   \item{ows}{offensive win share, a number}
#'   \item{dws}{defensive win share, a number}
#'   \item{ws}{win shares, a number}
#'   \item{ws_48}{win shares per 48 minutes, a n umber}
#'   \item{obpm}{offensive box plus/minus, a number}
#'   \item{dbpm}{defensive box plus/minus, a number}
#'   \item{bpm}{box plus/minus, a number}
#'   \item{vorp}{value over replacement player, a number}
#' }
#' @source \url{ https://www.basketball-reference.com/leagues/NBA_2018_advanced.html}
"nba_stats"

#' NBA teams details.
#'
#' A dataset the teams in the NBA. Each team is
#' part of a conference and a division.
#'
#' @format A data frame with 31 rows and 3 variables
#' \describe{
#'   \item{tm}{team, name of the team. TOT stands for total. A player who has played for multiple teams is assigned TOT.}
#'   \item{conf}{conference, conference is east or west}
#'   \item{division}{division, division is atlantic, central, northwest, pacific, southeast, southwest or tot}
#' }
#' @source \url{ http://www.nba.com/standings/team_record_comparison/conferenceNew_Std_Div_mobile.html}
"nba_teams"

#' NBA all star players.
#'
#' A dataset of the all star game players.
#'
#'
#' @format A data frame with 12 rows and 2 variables
#' \describe{
#'   \item{team_lebron}{Players chosen by Lebron James}
#'   \item{team_stephen}{Players chosen by Stephen Curry}
#' }
#' @source \url{https://fr.wikipedia.org/wiki/NBA_All-Star_Game_2018}
"all_star_players"

#' NBA players salary.
#'
#' A dataset of the all star game players.
#'
#'
#' @format A data frame with 573 rows and 2 variables
#' \describe{
#'   \item{player}{player name}
#'   \item{salary}{salary}
#' }
#' @source \url{https://www.kaggle.com/koki25ando/salary}
"nba_salary"