Skip to contents

Fit method for trending_model objects

Source: R/fit-trending_model.R
fit.trending_model.Rd

Fits the specified model to the input data

Usage

# S3 method for trending_model
fit(x, data, as_tibble = TRUE, ...)

Arguments

x

An R object

data

A data frame containing the data to fit.

as_tibble

Should the output be converted to a tibble subclass.

...

Not currently used.

Value

If as_tibble = FALSE, then a trending_fit object is returned. This is a list subclass with entries:

  • result: the resulting fit from calling the underlying model directly, i.e.

    • lm_model: a fitted model object of class lm

    • glm_model: a fitted model object of class glm

    • glm_nb_model: a fitted model object of class negbin

    • brm_model: An object of class brmsfit

    NULL if fitting fails.

  • warnings: any warnings generated during fitting

  • errors: any errors generated during fitting

If as_tibble = TRUE, a trending_fit_tbl object which is a tibble subclass with one row for each model and columns 'result', 'warnings' and 'errors' with contents as above.

See also

fit.list()

Author

Tim Taylor

Examples

x = rnorm(100, mean = 0)
y = rpois(n = 100, lambda = exp(1.5 + 0.5*x))
dat <- data.frame(x = x, y = y)

poisson_model <- glm_model(y ~ x , family = poisson)
negbin_model <- glm_nb_model(y ~ x)

fit(poisson_model, dat)
#> <trending_fit_tbl> 1 x 3
#>   result warnings errors
#>   <list> <list>   <list>
#> 1 <glm>  <NULL>   <NULL>
fit(negbin_model, dat)
#> <trending_fit_tbl> 1 x 3
#>   result   warnings errors
#>   <list>   <list>   <list>
#> 1 <negbin> <NULL>   <NULL>
fit(list(poisson_model, negbin_model), dat)
#> <trending_fit_tbl> 2 x 3
#>   result warnings errors   
#>   <list> <list>   <list>   
#> 1 <NULL> <NULL>   <chr [1]>
#> 2 <NULL> <NULL>   <chr [1]>
fit(list(pm = poisson_model, nm = negbin_model), dat)
#> <trending_fit_tbl> 2 x 4
#>   model_name result       warnings     errors      
#>   <chr>      <named list> <named list> <named list>
#> 1 pm         <NULL>       <NULL>       <chr [1]>   
#> 2 nm         <NULL>       <NULL>       <chr [1]>