R/RcappeR.R

In durtal/RcappeR: Tools to aid the analysis and handicapping of Thoroughbred Horse Racing

#' RcappeR
#'
#' Tools to aid the analysis and handicapping of Thoroughbred Horse Racing
#'
#' A collection of tools to aid the analysis and handicapping of Thoroughbred
#' Horse Racing.  The primary tool \link{zipf_init} initialises a handicap
#' using race standardisation, which establishes the merits of a horses'
#' performance in a race by comparing it with different, but similar races.
#' Other tools, \link{zipf_hcp} and \link{zipf_race} help maintain a handicap.
#' The package also includes various tools for cleaning and preparing data for
#' analysis, and the use of the primary functions.
#'
#' @author Thomas Heslop
#' @name RcappeR
#' @aliases RcappeR-package
#' @docType package
NULL

#' BHA lengths per second scale
#'
#' Dataset containing the lengths per second scale employed by the BHA
#'
#' @section Variables:
#' \itemize{
#'      \item race_type type of race, flat (f) or national hunt (nh)
#'      \item going official going
#'      \item scale lengths per second scale
#'      \item conditions abbreviated concatenation of \strong{race_type}
#'      and \strong{going}
#' }
#'
#' @docType data
#' @keywords dataset
#' @name bhascale
#' @source \href{http://www.britishhorseracing.com/wp-content/uploads/2014/04/Lengths-Per-Second-Scale-Tables.pdf}{BHA Scale PDF}
NULL

#' Example Dataset
#'
#' Dataset of two fictional races, to highlight use of a few functions
#'
#' @section Variables:
#' \itemize{
#'      \item date race date
#'      \item time race start time
#'      \item pos finishing position
#'      \item horse horse name
#'      \item wintime winners final time
#'      \item going official going
#'      \item code race code, flat or national hunt race
#'      \item btn_l beaten lengths
#'      \item dist race distance
#' }
#'
#' @docType data
#' @keywords dataset
#' @name example_race
NULL

#' Gulfstream Park Dataset
#'
#' Dataset containing actual races from Gulfstream Park run in 2013 over 6 and
#' 8 furlongs on the dirt.
#'
#' @format
#' 2863 rows
#' 17 columns
#' @section Variables:
#' \itemize{
#'      \item date race date
#'      \item race race number
#'      \item race_type type of race, or class of race ("clm", 
#'      "mdn clm")
#'      \item dist race distance (furlongs)
#'      \item surf surface (all dirt in this case)
#'      \item value race value (or purse)
#'      \item going official going
#'      \item trainer horse trainer
#'      \item jockey horse jockey
#'      \item j_clm jockey claim (any weight, in lbs, taken off horse)
#'      \item age horse's age
#'      \item wgt weight carried
#'      \item gate starting gate
#'      \item pos finishing position
#'      \item horse horse
#'      \item fintime final time
#'      \item sect_4f time recorded over first 4 furlongs
#' }
#'
#' @docType data
#' @keywords dataset
#' @name gulfstream
NULL