Create parameter documentation to inherit
Source:R/internal_inherit_params.R
CausalQueries_internal_inherit_params.Rd
Create parameter documentation to inherit
Usage
CausalQueries_internal_inherit_params(
model,
query,
join_by,
parameters,
P,
A,
data,
data_events,
node,
statement,
using,
n_draws
)
Arguments
- model
A
causal_model
. A model object generated bymake_model
.- query
A character string. An expression defining nodal types to interrogate. An expression of the form "Y[X=1]" asks for the value of Y when X is set to 1
- join_by
A logical operator. Used to connect causal statements: AND ('&') or OR ('|'). Defaults to '|'.
- parameters
A vector of real numbers in [0,1]. Values of parameters to specify (optional). By default, parameters is drawn from the parameters dataframe. See
inspect(model, "parameters_df")
.- P
A
data.frame
. Parameter matrix. Not required but may be provided to avoid repeated computation for simulations. Seeinspect(model, "parameter_matrix")
.- A
A
data.frame
. Ambiguities matrix. Not required but may be provided to avoid repeated computation for simulations.inspect(model, "ambiguities_matrix")
- data
A
data.frame
. Data of nodes that can take three values: 0, 1, and NA. In long form as generated bymake_events
- data_events
A 'compact'
data.frame
with one row per data type. Must be compatible with nodes inmodel
. The default columns areevent
,strategy
andcount
.- node
A character string. The quoted name of a node.
- statement
A character string. A quoted causal statement.
- using
A character string. Indicates whether to use `priors`, `posteriors` or `parameters`.
- n_draws
An integer. If no prior distribution is provided, generate prior distribution with
n_draws
number of draws.