diff --git a/NEWS.md b/NEWS.md index 4de8498..d8fb439 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,7 @@ # nflseedR 1.2.0 * `simulate_nfl()` gained the new argument `sim_include` to allow more access to what is actually being simulated. This makes it possible skip playoff simulation or the (possibly heavy) computation of draft order. (#34) -* The `summary` method `summary.nflseedR_simulation()` now hides columns where all values are `NA`. This is useful if `simulate_nfl()` skips the postseason or draft order. The method also reformats the number of simulations in the subtitle, e.g. from "10000" to "10k" (this requires scales >= 1.2.0, but it is a good idea to update scales anyways). (#35) +* The `summary` method `summary.nflseedR_simulation()` now hides columns where all values are `NA`. This is useful if `simulate_nfl()` skips the postseason or draft order. The method also re-formats the number of simulations in the subtitle, e.g. from "10000" to "10k" (this requires scales >= 1.2.0, but it is a good idea to update scales anyways). (#35) * `simulate_nfl()` now uses data.table to combine simulation rounds data. This is a significant performance improvement. The returned list `"sim_params"` now includes the package version of nflseedR (for debugging) and the current system time when the simulation was finished. (#36) * Lots of internal improvements to reduce package dependencies and messaging. (#36) * The `summary` method `summary.nflseedR_simulation()` now uses `fmt_pct_special()` to format probability strings to avoid the impression of overconfidence by rounding to integer percentages. (#37) diff --git a/R/simulate_nfl.R b/R/simulate_nfl.R index 325538b..11c491b 100644 --- a/R/simulate_nfl.R +++ b/R/simulate_nfl.R @@ -84,7 +84,7 @@ #' @returns An `nflseedR_simulation` object containing a list of 6 data frames #' data frames with the results of all simulated games, #' the final standings in each simulated season (incl. playoffs and draft order), -#' summary statistics across all simulated seasons, and the siumulation parameters. For a full list, +#' summary statistics across all simulated seasons, and the simulation parameters. For a full list, #' please see [the package website](https://nflseedr.com/articles/articles/nflsim.html#simulation-output). #' @seealso The examples [on the package website](https://nflseedr.com/articles/articles/nflsim.html) #' @seealso The method [nflseedR::summary.nflseedR_simulation()] that creates a pretty html summary table. diff --git a/man/simulate_nfl.Rd b/man/simulate_nfl.Rd index 761c22f..658ce50 100644 --- a/man/simulate_nfl.Rd +++ b/man/simulate_nfl.Rd @@ -83,7 +83,7 @@ Simulation will behave as follows: An \code{nflseedR_simulation} object containing a list of 6 data frames data frames with the results of all simulated games, the final standings in each simulated season (incl. playoffs and draft order), -summary statistics across all simulated seasons, and the siumulation parameters. For a full list, +summary statistics across all simulated seasons, and the simulation parameters. For a full list, please see \href{https://nflseedr.com/articles/articles/nflsim.html#simulation-output}{the package website}. } \description{