nlrx0.4.5 package

Setup, Run and Analyze 'NetLogo' Model Simulations from 'R' via 'XML'

analyze_eFast

Analyze NetLogo simulation output of simdesign eFast

analyze_ff

Analyze NetLogo simulation output of simdesign full-factorial

analyze_lhs

Analyze NetLogo simulation output of simdesign latin-hypercube

analyze_morris

Analyze NetLogo simulation output of simdesign morris

analyze_nl

Analyze NetLogo simulation output

analyze_simple

Analyze NetLogo simulation output of simdesign simple

analyze_sobol

Analyze NetLogo simulation output of simdesign sobol

analyze_sobol2007

Analyze NetLogo simulation output of simdesign sobol2007

analyze_soboljansen

Analyze NetLogo simulation output of simdesign soboljansen

check_netlogo_version

Check supported NetLogo versions

download_netlogo

Download NetLogo

eval_simoutput

Evaluate input/output integrity

eval_variables_constants

Evaluate variable validity

experiment

Construct a new experiment object

export_nl

Export NetLogo Experiment

getexp

Getter function to get a variable of an experiment object

getnl

Getter function to get a variable of a nl object

getsim

Getter function to get a variable of a simdesign object

import_nl

Import NetLogo Experiment

init-classes

initClasses

nl

Construct a new nl object

nl_to_graph

Generate igraph objects from measured turtles and links metrics

nl_to_points

Get spatial data from metrics.turtles output

nl_to_raster

Get spatial data from metrics.patches output

nldoc

Create NetLogo documentation

nldoc_find_procedure_calls

Determine procedure calls

nldoc_network

Create NetLogo procedure network

nldoc_parse_modelcode

Parse model code

nldoc_read_nlogo

Read NetLogo model code from files

nldoc_table_bs

Read NetLogo behavior space experiments from files

nldoc_table_gui

Read NetLogo GUI elements from files

nldoc_write_nldoc

Write NetLogo documentation

nlrx-package

nlrx: A package for running NetLogo simulations from R.

pipe

Pipe operator

print.nl

Print content of nl object

report_model_parameters

Report globals from a NetLogo model that is defined within a nl object

run_nl_all

Execute all NetLogo simulations from a nl object

run_nl_dyn

Execute NetLogo simulation without pregenerated parametersets

run_nl_one

Execute one NetLogo simulation from a nl object

setexp

Setter function to set a variable of an experiment object

setnl

Setter function to set a variable of a nl object

setsim

Setter function to set a variable of a simdesign object

simdesign

Construct a new simdesign object

simdesign_ABCmcmc_Marjoram

Add an Approximate Bayesian Computation (Monte-Carlo Markov-Chain) sim...

simdesign_ABCmcmc_Marjoram_original

Add an Approximate Bayesian Computation (Monte-Carlo Markov-Chain) sim...

simdesign_ABCmcmc_Wegmann

Add an Approximate Bayesian Computation (Monte-Carlo Markov-Chain) sim...

simdesign_distinct

Add a distinct simdesign to a nl object

simdesign_eFast

Add an eFast simdesign to a nl object

simdesign_ff

Add a full-factorial simdesign to a nl object

simdesign_GenAlg

Add a Genetic Algorithm simdesign to a nl object

simdesign_GenSA

Add a Simulated Annealing simdesign to a nl object

simdesign_lhs

Add a latin-hypercube simdesign to a nl object

simdesign_morris

Add a morris elementary effects simdesign to a nl object

simdesign_simple

Add a simple simdesign to a nl object

simdesign_sobol

Add a sobol simdesign to a nl object

simdesign_sobol2007

Add a sobol2007 simdesign to a nl object

simdesign_soboljansen

Add a soboljansen simdesign to a nl object

supported_netlogo_versions

Report supported NetLogo versions

test_nlrx

Test if nlrx runs on the local system

unnest_simoutput

Get spatial data from metrics.turtles and metrics.patches output

util_call_nl

Setup and execute NetLogo via command line

util_cleanup

Delete temporary files

util_create_agentset_reporter

Create turtle/patches/links owns reporter

util_create_lhs

Identify and report the current OS

util_create_sim_XML

Create a temporary behavior space xml file to setup NetLogo via comman...

util_eval_constants

Evaluate if constants list of an experiment object is empty

util_eval_experiment

Evaluate all slots of an experiment object

util_eval_simdesign

Evaluate all slots of a simdesign object

util_eval_variables

Evaluate if variables list of an experiment object is empty

util_eval_variables_distinct

Evaluate variables list of an experiment object for distinct simdesign

util_eval_variables_ff

Evaluate variables list of an experiment object for full-factorial sim...

util_eval_variables_op

Evaluate variables list of an experiment object for optimization simde...

util_eval_variables_sa

Evaluate variables list of an experiment object for sensitivity analys...

util_gather_results

Load output file from simulations

util_generate_seeds

Generate a vector of random seeds

util_get_os

Identify and report the current OS

util_print.experiment

Print experiment object content

util_print.nl

Print nl object content

util_print.simdesign

Print simdesign object content

util_print.summary

Print nl object summary

util_read_write_batch

Write a modified batchfile that executes NetLogo

util_run_nl_dyn_ABCmcmc

ABCmcmc call simulations function

util_run_nl_dyn_GenAlg

Genetic Algorithm call simulations function

util_run_nl_dyn_GenAlg_fn

Genetic Algorithm run simulation function

util_run_nl_dyn_GenSA

Simulated Annealing call simulations function

util_run_nl_dyn_GenSA_fn

Simulated Annealing run simulation function

write_simoutput

Write attached NetLogo simulation output to file

Setup, run and analyze 'NetLogo' (<https://ccl.northwestern.edu/netlogo/>) model simulations in 'R'. 'nlrx' experiments use a similar structure as 'NetLogos' Behavior Space experiments. However, 'nlrx' offers more flexibility and additional tools for running and analyzing complex simulation designs and sensitivity analyses. The user defines all information that is needed in an intuitive framework, using class objects. Experiments are submitted from 'R' to 'NetLogo' via 'XML' files that are dynamically written, based on specifications defined by the user. By nesting model calls in future environments, large simulation design with many runs can be executed in parallel. This also enables simulating 'NetLogo' experiments on remote high performance computing machines. In order to use this package, 'Java' and 'NetLogo' (>= 5.3.1) need to be available on the executing system.

  • Maintainer: Sebastian Hanss
  • License: GPL-3
  • Last published: 2024-01-29