Skip to content

Commit

Permalink
Move the break-everything name change thing to a Breaking changes sec…
Browse files Browse the repository at this point in the history
…tion; document changes to derivatives; bump version
  • Loading branch information
gavinsimpson committed Jan 3, 2024
1 parent c4dbf08 commit 4b0cb25
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: gratia
Version: 0.8.1.40
Version: 0.8.1.50
Date: 2024-01-03
Title: Graceful 'ggplot'-Based Graphics and Other Functions for GAMs Fitted Using 'mgcv'
Authors@R: c(person(given = "Gavin L.", family = "Simpson",
Expand Down
21 changes: 14 additions & 7 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# gratia 0.8.1.49
# gratia 0.8.1.50

## User visible changes
## Breaking changes

* Many functions now return objects with different named variables. In order to
avoid clashes with variable names used in user's models or data, a period
(`.`) is now being used as a prefix for generated variable names. The
functions whose names have changed are: `smooth_estimates()`,
`fitted_values()`, `fitted_samples()`, `posterior_samples()`, and
`derivative_samples()`. In addition, `add_confint()` also adds newly-named
variables.
`fitted_values()`, `fitted_samples()`, `posterior_samples()`, `derivatives()`,
`partial_derivatives()`, and `derivative_samples()`. In addition,
`add_confint()` also adds newly-named variables.

1. `est` is now `.estimate`,
2. `lower` and `upper` are now `.lower_ci` and `.upper_ci`,
3. `draw` and `row` and now `.draw` and `.row` respectively,
4. `fitted`, `se`, `crit` are now `.fitted`, `.se`, `.crit`, respectively
5. `smooth`, `by`, and `type` in `smooth_estimates()` are now `.smooth`,
`.by`, `.type`, respectively.
`.by`, `.type`, respectively.

* `derivatives()` and `partial_derivatives()` now work more like
`smooth_estimates()`; in place of the `var` and `data` columns, *gratia* now
stores the data variables at which the derivatives were evaluated as columns
in the object with their actual variable names.

## User visible changes

* `smooth_samples()` now uses a single call to the RNG to generate draws from
the posterior of smooths. Previous to version 0.9.0, `smooth_samples()` would
Expand All @@ -40,7 +47,7 @@
This also affects `draw.gam()`.

* `fitted_values()` now has some level of support for location, scale, shape
families. Suppoerted families are `mgcv::gaulss()`, `mgcv::gumbls()`,
families. Supported families are `mgcv::gaulss()`, `mgcv::gumbls()`,
`mgcv::gevlss()`, `mgcv::gumbls()`, `mgcv::shash()`, `mgcv::twlss()`, and
`mgcv::ziplss()`.

Expand Down

0 comments on commit 4b0cb25

Please sign in to comment.