fix variables docstring

Author: thorek1

ext/StatsPlotsExt.jl

@@ -131,7 +131,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - $PARAMETERS®
 - $ALGORITHM®
 - $FILTER®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - `shocks` [Default: `:all`]: shocks for which to plot the estimates. Inputs can be either a `Symbol` (e.g. `:y`, or `:all`), `Tuple{Symbol, Vararg{Symbol}}`, `Matrix{Symbol}`, or `Vector{Symbol}`.
 - `presample_periods` [Default: `0`, Type: `Int`]: periods at the beginning of the data which are not plotted. Useful if you want to filter for all periods but focus only on a certain period later in the sample.
 - $DATA_IN_LEVELS®
@@ -613,7 +613,7 @@ This function shares most of the signature and functionality of [`plot_model_est
 - $PARAMETERS®
 - $ALGORITHM®
 - $FILTER®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - `shocks` [Default: `:all`]: shocks for which to plot the estimates. Inputs can be either a `Symbol` (e.g. `:y`, or `:all`), `Tuple{Symbol, Vararg{Symbol}}`, `Matrix{Symbol}`, or `Vector{Symbol}`.
 - `presample_periods` [Default: `0`, Type: `Int`]: periods at the beginning of the data which are not plotted. Useful if you want to filter for all periods but focus only on a certain period later in the sample.
 - $DATA_IN_LEVELS®
@@ -1427,7 +1427,7 @@ If the model contains occasionally binding constraints and `ignore_obc = false`
 # Keyword Arguments
 - $PERIODS®
 - $SHOCKS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_AUX_AND_OBC))
 - $PARAMETERS®
 - $ALGORITHM®
 - $SHOCK_SIZE®
@@ -2072,7 +2072,7 @@ This function shares most of the signature and functionality of [`plot_irf`](@re
 # Keyword Arguments
 - $PERIODS®
 - $SHOCKS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_AUX_AND_OBC))
 - $PARAMETERS®
 - $ALGORITHM®
 - $SHOCK_SIZE®
@@ -3147,7 +3147,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - $MODEL®
 # Keyword Arguments
 - $PERIODS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLE_SELECTION))
 - $PARAMETERS®
 - $SHOW_PLOTS®
 - $SAVE_PLOTS®
@@ -3411,7 +3411,7 @@ If the model contains occasionally binding constraints and `ignore_obc = false`
 - $MODEL®
 - `state` [Type: `Union{Symbol,String}`]: state variable to be shown on x-axis.
 # Keyword Arguments
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLE_SELECTION))
 - $ALGORITHM®
 - `σ` [Default: `2`, Type: `Union{Int64,Float64}`]: defines the range of the state variable around the (non) stochastic steady state in standard deviations. E.g. a value of 2 means that the state variable is plotted for values of the (non) stochastic steady state in standard deviations +/- 2 standard deviations.
 - $PARAMETERS®
@@ -4059,7 +4059,7 @@ If the model contains occasionally binding constraints and `ignore_obc = false`
 - $MODEL®
 - `state` [Type: `Union{Symbol,String}`]: state variable to be shown on x-axis.
 # Keyword Arguments
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLE_SELECTION))
 - $ALGORITHM®
 - `σ` [Default: `2`, Type: `Union{Int64,Float64}`]: defines the range of the state variable around the (non) stochastic steady state in standard deviations. E.g. a value of 2 means that the state variable is plotted for values of the (non) stochastic steady state in standard deviations +/- 2 standard deviations.
 - $PARAMETERS®
@@ -4318,7 +4318,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - $INITIAL_STATE®
 - `periods` [Default: `40`, Type: `Int`]: the total number of periods is the sum of the argument provided here and the maximum of periods of the shocks or conditions argument.
 - $PARAMETERS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - `conditions_in_levels` [Default: `true`, Type: `Bool`]: indicator whether the conditions are provided in levels. If `true` the input to the conditions argument will have the non-stochastic steady state subtracted.
 - $ALGORITHM®
 - `label` [Default: `1`, Type: `Union{Real, String, Symbol}`]: label to attribute to this function call in the plots.
@@ -4762,7 +4762,7 @@ This function shares most of the signature and functionality of [`plot_condition
 - $INITIAL_STATE®
 - `periods` [Default: `40`, Type: `Int`]: the total number of periods is the sum of the argument provided here and the maximum of periods of the shocks or conditions argument.
 - $PARAMETERS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - `conditions_in_levels` [Default: `true`, Type: `Bool`]: indicator whether the conditions are provided in levels. If `true` the input to the conditions argument will have the non-stochastic steady state subtracted.
 - $ALGORITHM®
 - $LABEL®

src/common_docstrings.jl

@@ -2,7 +2,8 @@
 const MODEL® = "`𝓂`: object created by [`@model`](@ref) and [`@parameters`](@ref)."
 const PARAMETER_VALUES® = "`parameters` [Type: `Vector`]: Parameter values in alphabetical order (sorted by parameter name)."
 const PARAMETERS® = "`parameters` [Default: `nothing`]: If `nothing` is provided, the solution is calculated for the parameters defined previously. Acceptable inputs are a `Vector` of parameter values, a `Vector` or `Tuple` of `Pair`s of the parameter `Symbol` or `String` and value. If the new parameter values differ from the previously defined the solution will be recalculated."
-const VARIABLES® = "`variables` [Default: `$(DEFAULT_VARIABLES_EXCLUDING_OBC)`]: variables for which to show the results. Inputs can be a variable name passed on as either a `Symbol` or `String` (e.g. `:y` or \"y\"), or `Tuple`, `Matrix` or `Vector` of `String` or `Symbol`. Any variables not part of the model will trigger a warning. `$(DEFAULT_VARIABLES_EXCLUDING_AUX_AND_OBC)` contains all shocks less those related to auxiliary variables and related to occasionally binding constraints (obc). `$(DEFAULT_VARIABLES_EXCLUDING_OBC)` contains all shocks less those related to auxiliary variables. `$(DEFAULT_VARIABLE_SELECTION)` will contain all variables."
+# const VARIABLES® = "`variables` [Default: `$(DEFAULT_VARIABLES_EXCLUDING_OBC)`]: variables for which to show the results. Inputs can be a variable name passed on as either a `Symbol` or `String` (e.g. `:y` or \"y\"), or `Tuple`, `Matrix` or `Vector` of `String` or `Symbol`. Any variables not part of the model will trigger a warning. `$(DEFAULT_VARIABLES_EXCLUDING_AUX_AND_OBC)` contains all shocks less those related to auxiliary variables and related to occasionally binding constraints (obc). `$(DEFAULT_VARIABLES_EXCLUDING_OBC)` contains all shocks less those related to auxiliary variables. `$(DEFAULT_VARIABLE_SELECTION)` will contain all variables."
+VARIABLES® = x -> "`variables` [Default: `$x`]: variables for which to show the results. Inputs can be a variable name passed on as either a `Symbol` or `String` (e.g. `:y` or \"y\"), or `Tuple`, `Matrix` or `Vector` of `String` or `Symbol`. Any variables not part of the model will trigger a warning. `$(DEFAULT_VARIABLES_EXCLUDING_AUX_AND_OBC)` contains all shocks less those related to auxiliary variables and related to occasionally binding constraints (obc). `$(DEFAULT_VARIABLES_EXCLUDING_OBC)` contains all shocks less those related to auxiliary variables. `$(DEFAULT_VARIABLE_SELECTION)` will contain all variables."
 const SHOCKS® = "`shocks` [Default: `$(DEFAULT_SHOCKS_EXCLUDING_OBC)`]: shocks for which to calculate the IRFs. Inputs can be a shock name passed on as either a `Symbol` or `String` (e.g. `:y`, or \"y\"), or `Tuple`, `Matrix` or `Vector` of `String` or `Symbol`. `:simulate` triggers random draws of all shocks (excluding occasionally binding constraints (obc) related shocks). `$(DEFAULT_SHOCKS_EXCLUDING_OBC)` will contain all shocks but not the obc related ones. `$(DEFAULT_SHOCK_SELECTION)` will contain also the obc related shocks. A series of shocks can be passed on using either a `Matrix{Float64}`, or a `KeyedArray{Float64}` as input with shocks (`Symbol` or `String`) in rows and periods in columns. The `KeyedArray` type is provided by the `AxisKeys` package. The period of the simulation will correspond to the length of the input in the period dimension + the number of periods defined in `periods`. If the series of shocks is input as a `KeyedArray{Float64}` make sure to name the rows with valid shock names of type `Symbol`. Any shocks not part of the model will trigger a warning. `:none` in combination with an `initial_state` can be used for deterministic simulations."
 const DERIVATIVES® = "`derivatives` [Default: `$(DEFAULT_DERIVATIVES_FLAG)`, Type: `Bool`]: calculate derivatives with respect to the parameters."
 const PERIODS® = "`periods` [Default: `$(DEFAULT_PERIODS)`, Type: `Int`]: number of periods for which to calculate the output. In case a matrix of shocks was provided, periods defines how many periods after the series of shocks the output continues."

src/get_functions.jl

@@ -645,7 +645,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - $INITIAL_STATE®
 - `periods` [Default: `40`, Type: `Int`]: the total number of periods is the sum of the argument provided here and the maximum of periods of the shocks or conditions argument.
 - $PARAMETERS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - `conditions_in_levels` [Default: `true`, Type: `Bool`]: indicator whether the conditions are provided in levels. If `true` the input to the conditions argument will have the non-stochastic steady state subtracted.
 - `levels` [Default: `false`, Type: `Bool`]: $LEVELS®
 - $ALGORITHM®
@@ -1016,7 +1016,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - $PARAMETER_VALUES®
 # Keyword Arguments
 - $PERIODS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - $SHOCKS®
 - $NEGATIVE_SHOCK®
 - $INITIAL_STATE®1
@@ -1151,7 +1151,7 @@ If the model contains occasionally binding constraints and `ignore_obc = false`
 - $PERIODS®
 - $ALGORITHM®
 - $PARAMETERS®
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - $SHOCKS®
 - $NEGATIVE_SHOCK®
 - $GENERALISED_IRF®
@@ -2596,7 +2596,7 @@ If occasionally binding constraints are present in the model, they are not taken
 - `standard_deviation` [Default: `true`, Type: `Bool`]: switch to return standard deviation of endogenous variables
 - `variance` [Default: `false`, Type: `Bool`]: switch to return variance of endogenous variables
 - `covariance` [Default: `false`, Type: `Bool`]: switch to return covariance matrix of endogenous variables
-- $VARIABLES®
+- $(VARIABLES®(DEFAULT_VARIABLES_EXCLUDING_OBC))
 - $DERIVATIVES®
 - $PARAMETER_DERIVATIVES®
 - $ALGORITHM®