Package: simulator 0.2.4

simulator: An Engine for Running Simulations

A framework for performing simulations such as those common in methodological statistics papers. The design principles of this package are described in greater depth in Bien, J. (2016) "The simulator: An Engine to Streamline Simulations," which is available at <arxiv:1607.00021>.

Authors:Jacob Bien [aut, cre]

simulator_0.2.4.tar.gz
simulator_0.2.4.zip(r-4.5)simulator_0.2.4.zip(r-4.4)simulator_0.2.4.zip(r-4.3)
simulator_0.2.4.tgz(r-4.4-any)simulator_0.2.4.tgz(r-4.3-any)
simulator_0.2.4.tar.gz(r-4.5-noble)simulator_0.2.4.tar.gz(r-4.4-noble)
simulator_0.2.4.tgz(r-4.4-emscripten)simulator_0.2.4.tgz(r-4.3-emscripten)
simulator.pdf |simulator.html✨
simulator/json (API)

# Install 'simulator' in R:
install.packages('simulator', repos = c('https://jacobbien.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/jacobbien/simulator/issues

On CRAN:

simulation

7.03 score 52 stars 83 scripts 159 downloads 44 exports 1 dependencies

Last updated 2 years agofrom:3d325ec78d. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 23 2024
R-4.5-winNOTENov 23 2024
R-4.5-linuxNOTENov 23 2024
R-4.4-winNOTENov 23 2024
R-4.4-macNOTENov 23 2024
R-4.3-winOKNov 23 2024
R-4.3-macOKNov 23 2024

Exports:%>%addcreatedescribedrawsevalsevaluategenerate_modelget_contentsget_files_not_in_simulationsget_simulation_with_all_filesloadload_drawsload_evalsload_evals_from_refload_modelload_outputsload_simulationmake_my_example_modelmemory_as_stringmodelmodel_namesmy_example_lossmy_example_methodnew_aggregatornew_extended_methodnew_methodnew_method_extensionnew_metricnew_modelnew_simulationoutputplot_evalplot_eval_byplot_evalsrelabelrenamerun_methodsave_simulationsimulate_from_modelsubset_evalssubset_modelssubset_simulationtabulate_eval

Dependencies:magrittr

Benjamini-Hochberg Procedure with the Simulator

Rendered fromfdr.Rmdusingknitr::rmarkdownon Nov 23 2024.

Last update: 2023-02-02
Started: 2016-06-29

Getting Started with the Simulator

Rendered fromsimulator.Rmdusingknitr::rmarkdownon Nov 23 2024.

Last update: 2023-02-02
Started: 2023-02-02

James-Stein with the Simulator

Rendered fromjames-stein.Rmdusingknitr::rmarkdownon Nov 23 2024.

Last update: 2023-02-02
Started: 2016-06-29

The Elastic Net with the Simulator

Rendered fromelastic-net.Rmdusingknitr::rmarkdownon Nov 23 2024.

Last update: 2023-02-02
Started: 2016-06-29

The Lasso with the Simulator

Rendered fromlasso.Rmdusingknitr::rmarkdownon Nov 23 2024.

Last update: 2023-02-02
Started: 2016-06-29

Readme and manuals

Help Manual

Help pageTopics
Create an ExtendedMethod from an ExtendedMethod and MethodExtension+,ExtendedMethod,MethodExtension-method
Create a list of ExtendedMethod from a list of Methods and a MethodExtension+,list,MethodExtension-method
Create an ExtendedMethod from a Method and MethodExtension+,Method,MethodExtension-method
Get element of 'Model''s 'params' list$,Model-method
Add a reference to a simulationadd add,Simulation,DrawsRef-method add,Simulation,EvalsRef-method add,Simulation,list-method add,Simulation,ModelRef-method add,Simulation,OutputRef-method
Make a string bold in a certain formatadd_bold
Apply aggregator to a list of Evals objectsaggregate_evals
An S4 class for aggregating evaluated metricsAggregator-class
Convert an Evals to a data.frameas.data.frame.Evals
Convert a list of Evals to a data.frameas.data.frame.listofEvals
Convert a List of Models to a data.frameas.data.frame.listofModels
Convert a Model to a data.frameas.data.frame.Model
Concatenate and print for the simulatorcatsim
An S4 class representing a component of the simulator.Component-class
Create template for a new set of simulationscreate
Describe the contents of a simulator directorydescribe
Get one or more draws from a simulationdraws
An S4 class representing the random draws from a Model object.Draws-class
An S4 class representing a reference to an object of class Draws.DrawsRef-class
Get one or more evals from a simulationevals
An S4 class representing the evaluation of a metric run by simulator.Evals-class
An S4 class representing a reference to an object of class EvalsEvalsRef-class
Evaluate outputs of methods according to provided metrics.evaluate
Evaluate outputs of methods according to provided metrics.evaluate_internal
Run one or more metrics on outputs.evaluate_single
An S4 class representing the extension of a methodExtendedMethod-class
Generate a model.generate_model
Get the contents of a simulator directoryget_contents
Find files in simulator directory not referred to by any simulationsget_files_not_in_simulations
Returns indices of a specified subset of sim@model_refsget_model_indices
Get relative pathget_relative_path
Returns a simulation object containing references to all files in directoryget_simulation_with_all_files
Load one or more draws objects from file.load_draws
Load one or more Evals objects from file.load_evals load_evals_from_ref
Load a model from file.load_model
Load a simulation objectload_simulation
Load a DrawsRefload,DrawsRef-method
Load an EvalsRefload,EvalsRef-method
Load a list of reference objectsload,list-method
Load a ModelRefload,ModelRef-method
Load an OutputRefload,OutputRef-method
Make My Example Modelmake_my_example_model
Write memory in human readable waymemory_as_string
An S4 class representing a method to be run by simulator.Method-class
An S4 class used to create an extended version of a methodMethodExtension-class
An S4 class representing an evaluation metric to be used by simulator.Metric-class
Get one or more models from a simulationmodel
Get model names in a Simulationmodel_names
An S4 class representing the model component of the simulator.Model-class
An S4 class representing a reference to an object of class Model.ModelRef-class
Convert a list of Model objects into a data.framemodels_as_data.frame
My Example Lossmy_example_loss
My Example Methodmy_example_method
Create an Aggregator objectnew_aggregator
Create an ExtendedMethod objectnew_extended_method
Create a Method objectnew_method
Create an object that can be used to make an extended version of a methodnew_method_extension
Create a Metric objectnew_metric
Create a Model objectnew_model
Make a new simulation objectnew_simulation
Get one or more outputs from a simulationoutput
An S4 class representing the output of a method run by simulator.Output-class
An S4 class representing a reference to an object of class Output.OutputRef-class
Plot a metric's value for each methodplot_eval
Plot a metric across multiple values of a model parameterplot_eval_by
Plot one metric versus another for each methodplot_evals
Recycles elements to create vector of desired lengthrecycle
Give simulation a new labelrelabel
Give simulation a new namerename
Run a single extended method on a single index of simulated data.run_extendedmethod_single
Run one or more methods on simulated data.run_method
Run a single method on a single index of simulated data.run_method_single
Save a simulation objectsave_simulation
Simulate from a model.simulate_from_model
Simulate from a model.simulate_from_model_single
Simulate from a model in parallel.simulate_parallel
An S4 class representing a simulation.Simulation-class
Reduce an Evals object to a subset of methods and/or metricssubset_evals
Subset Modelssubset_models
Create a simulation that is a subset of a preexisting simulation objectsubset_simulation
Make a table of a metric for each pair of models and methodstabulate_eval