Package index • mrgsim.ds

Read or load models

Functions to read models configured for use with mrgsim_ds().

mread_ds() mcode_ds() modlib_ds() house_ds() mread_cache_ds(): Read a model specification file for 'Apache' 'Arrow'-backed simulation outputs

Generate Apache Arrow Dataset-backed simulation outputs

Simulate and write output to disk.

mrgsim_ds(): Simulate from a model object, returning an arrow-backed output object
as_mrgsim_ds(): Coerce an mrgsims object to 'Arrow'-backed mrgsimsds object

S3 Methods

Work with mrgsim_ds() output.

dim(<mrgsimsds>) head(<mrgsimsds>) tail(<mrgsimsds>) names(<mrgsimsds>) plot(<mrgsimsds>): Interact with mrgsimsds objects

Move or rename outputs

move_ds() rename_ds() write_ds(): Move, rename, or write out data set files

Manage or query ownership

This applies to parquet files holding simulation outputs.

ownership() list_ownership() check_ownership() disown() take_ownership(): Ownership of simulation files
copy_ds(): Copy an mrgsimsds object

Work with lists of mrgsimsds objects

Commonly needed after batch simulation in parallel

reduce_ds(): Reduce a list of mrgsimsds objects into a single object
refresh_ds(): Refresh 'Arrow' dataset pointers.
prune_ds(): Prune a list of mrgsimsds objects

Manage simulation outputs in `tempdir()`

list_temp() retain_temp() purge_temp(): Manage simulated outputs in tempdir()

Utility functions

file_ds(): Create an output file name
save_process_info(): Save information about the R process that loaded a model
is_mrgsimsds(): Check if object inherits mrgsimsds

Coerce output to an R object

as_tibble(<mrgsimsds>) collect(<mrgsimsds>) as.data.frame(<mrgsimsds>): Coerce an mrgsimsds object to a tbl
as_arrow_ds(): Coerce an mrgsimsds object to an arrow data set
as_arrow_table(<mrgsimsds>): Coerce an mrgsimsds object to an arrow table
as_duckdb_ds(): Coerce an mrgsimsds object to a DuckDB table

Landing page

mrgsim.ds: mrgsim.ds: 'Apache' 'Arrow' Dataset-Backed Simulation Outputs for 'mrgsolve'