logolink 1.0.0

Breaking Changes

• logolink now works only with NetLogo 7.0.1 and above. The NetLogo 7.0.1 patch release changed the XML structure of BehaviorSpace experiments; See this GitHub issue to learn more.
• run_experiment() now returns a list object containing the BehaviorSpace output formats and metadata information.
• run_experiment() had the parse argument removed. The function now offer an option to return a lists output via the new output parameter. Results containing data in NetLogo's lists format are returned as character vectors.
• run_experiment() had the netlogo_home and netlogo_path argument removed. The package now tries to automatically detect the NetLogo installation using helper functions (see find_netlogo_home()). Users can still manually specify the path to NetLogo. See the updated documentation for details.
• parse_netlogo_list() now always return a list object. The previous behavior of returning a vector when possible was removed.
• parse_netlogo_list() now returns NaN values as R NaN values instead of "NaN".
• inspect_experiment_file() was renamed to inspect_experiment().

New Features and Improvements

• run_experiment() now have a timeout parameter to specify the maximum time (in seconds) to wait for an experiment to complete before terminating it.
• run_experiment() now prints to the R console any messages returned by NetLogo while running the simulation.
• find_netlogo_home(), find_netlogo_console(), and find_netlogo_version() were introduced to the package. These functions use heuristics to automatically detect NetLogo installations on Windows, macOS, and Linux.
• create_experiment() now have a file parameter, allowing the user to specify the output file path for the generated BehaviorSpace experiment XML file.
• create_experiment() now supports multiple commands in arguments like setup and go as character vectors.
• create_experiment() now supports vectors in constants for enumerated value sets.
• create_experiment() now supports subexperiments.
• create_experiment() is now feature complete. It attends all the functionalities described in the XML File Format documentation.
• parse_netlogo_list() now have better heuristics.
• parse_netlogo_color() was introduced to parse NetLogo color strings into approximate hexadecimal color codes.
• get_netlogo_shape() was introduced to retrieve NetLogo shape definitions from the LogoShapes project.
• read_experiment() was introduced to read and tidy BehaviorSpace experiment output files into R.
• The package now checks logolink NetLogo integration via Continuous Integration (CI), performing tests on Windows, macOS, and Linux using GitHub Actions from the LogoActions project.
• New R unit tests were implemented.
• New NetLogo unit tests were implemented.
• A new vignette introducing the package was added.
• A new vignette showing how to visualize the NetLogo world using ggplot2 was added.
• The documentation was updated to reflect the changes in the package.