tar_stan_example_data: Simulate example data for 'tar_stan_example_file()'.

View source: R/tar_stan_example_data.R

tar_stan_example_dataR Documentation

Simulate example data for tar_stan_example_file().

Description

An example dataset compatible with the model file from tar_stan_example_file().

Usage

tar_stan_example_data(n = 10L)

Arguments

n

Integer of length 1, number of data points.

Format

A list with the following elements:

  • n: integer, number of data points.

  • x: numeric, covariate vector.

  • y: numeric, response variable.

  • true_beta: numeric of length 1, value of the regression coefficient beta used in simulation.

  • .join_data: a list of simulated values to be appended to as a .join_data column in the output of targets generated by functions such as tar_stan_mcmc_rep_summary(). Contains the regression coefficient beta (numeric of length 1) and prior predictive data y (numeric vector).

Details

The tar_stan_example_data() function draws a Stan dataset from the prior predictive distribution of the model from tar_stan_example_file(). First, the regression coefficient beta is drawn from its standard normal prior, and the covariate x is computed. Then, conditional on the beta draws and the covariate, the response vector y is drawn from its Normal(x * beta, 1) likelihood.

Value

List, dataset compatible with the model file from tar_stan_example_file().

See Also

Other examples: tar_stan_example_file()

Examples

tar_stan_example_data()

ropensci/stantargets documentation built on Feb. 8, 2025, 10:34 p.m.