# An Accessible Interface for Stock-and-Flow Modelling

## Documentation for package ‘sdbuildR’ version 2.2.3

- DESCRIPTION file.
- Package NEWS.

## Help Pages

%REM% | Remainder and modulus
as.data.frame | Data frame methods for sdbuildR objects
as.data.frame.ensemble_stockflow | Create data frame of simulation results
as.data.frame.simulate_stockflow | Create data frame of simulation results
as.data.frame.stockflow | Convert stock-and-flow model to data frame
as.data.frame.verify_stockflow | Convert verify() results to a data frame
aux | Add or modify auxiliaries
auxiliary | Add or modify auxiliaries
change_name | Change name of variable
change_type | Change variable type
clean_name | Clean variable name(s)
compare_models | Compare two stock-and-flow models
constant | Add or modify constants
contains_IM | Check whether value is in vector or string
custom_func | Create or modify custom variables or functions
dependencies | Find dependencies
discard | Remove variable(s)
discard_unit_test | Remove a unit test from a stock-and-flow model
ensemble | Run ensemble simulation
expit | Expit function
export_model | Export a stock-and-flow model
export_plot | Save plot to a file
flow | Add or modify flows
has_internet | Check if user has internet
head | First and last rows of sdbuildR results
head.simulate_stockflow | Print first rows of a simulation
head.verify_stockflow | Print first rows of verify results
hill | Hill function
import_desolve | Import a deSolve model
import_insightmaker | Import Insight Maker model
indexof | Find index of value in vector or string
insightmaker_to_json | Convert .InsightMaker file to .json file
install_julia_env | Install, update, or remove Julia environment
length_IM | Length of vector or string
logistic | Logistic function
logit | Logit function
lookup | Add or modify lookup variables (graphical functions)
meta | Modify meta of stock-and-flow model
mod | Remainder and modulus
nonnegative | Check whether x is less than zero
plot | Plot methods for sdbuildR objects
plot.ensemble_stockflow | Plot timeseries of ensemble simulation
plot.simulate_stockflow | Plot timeseries of simulation
plot.stockflow | Plot stock-and-flow diagram
plot.verify_stockflow | Plot verify results
print | Print methods for sdbuildR objects
print.compare_stockflow | Print comparison of two stock-and-flow models
print.simulate_stockflow | Print simulation of a stock-and-flow model
print.stockflow | Print overview of stock-and-flow model
print.summary_stockflow | Print method for summary_stockflow
pulse | Create pulse function
ramp | Create ramp function
rbool | Generate random logical value
rdist | Generate random number from custom distribution
rem | Remainder and modulus
ricker | Generalized Ricker function
round_IM | Round values half-up (as in Insight Maker)
saveat_func | Internal function to save data frame at specific times
sdbuildR-as.data.frame | Data frame methods for sdbuildR objects
sdbuildR-head-tail | First and last rows of sdbuildR results
sdbuildR-plot | Plot methods for sdbuildR objects
sdbuildR-print | Print methods for sdbuildR objects
sdbuildR-summary | Summary methods for sdbuildR objects
seasonal | Create a seasonal wave function
sigmoid | Logistic function
simulate | Simulate stock-and-flow model
simulate.stockflow | Simulate stock-and-flow model
sim_methods | Translate between deSolve and DifferentialEquations.jl solver names
sim_settings | Modify simulation specifications
step | Create step function
stock | Add or modify stocks
stockflow | Create a new stock-and-flow model
summary | Summary methods for sdbuildR objects
summary.simulate_stockflow | Summarize simulation results
summary.stockflow | Run model diagnostics
tail | First and last rows of sdbuildR results
tail.simulate_stockflow | Print last rows of a simulation
tail.verify_stockflow | Print last rows of verify results
unit_test | Add or modify unit tests
unit_tests | Display unit tests defined on a stock-and-flow model
update | Create or modify variables
update.stockflow | Create or modify variables
url_to_insightmaker | Extract Insight Maker model from URL
use_julia | Start Julia and activate environment
verify | Verify model behavior with unit tests
verify.stockflow | Verify unit tests against simulation results