Update README and Get Started Vignette

Author: danielvartan

.vscode/settings.json

@@ -81,6 +81,7 @@
     "lintr",
     "logoactions",
     "logolink",
+    "logopak",
     "logoshapes",
     "Lotka",
     "magick",

CITATION.cff

@@ -68,7 +68,7 @@ references:
     orcid: https://orcid.org/0000-0001-9754-0393
   year: '2026'
   doi: 10.32614/CRAN.package.checkmate
-  version: '>= 2.3.3'
+  version: '>= 2.3.4'
 - type: software
   title: cli
   abstract: 'cli: Helpers for Developing Command Line Interfaces'
@@ -107,7 +107,7 @@ references:
     orcid: https://orcid.org/0000-0003-4777-038X
   year: '2026'
   doi: 10.32614/CRAN.package.dplyr
-  version: '>= 1.1.4'
+  version: '>= 1.2.0'
 - type: software
   title: fs
   abstract: 'fs: Cross-Platform File System Operations Based on ''libuv'''
@@ -255,7 +255,7 @@ references:
     email: jeroenooms@gmail.com
   year: '2026'
   doi: 10.32614/CRAN.package.xml2
-  version: '>= 1.5.1'
+  version: '>= 1.5.2'
 - type: software
   title: bslib
   abstract: 'bslib: Custom ''Bootstrap'' ''Sass'' Themes for ''shiny'' and ''rmarkdown'''
@@ -276,7 +276,7 @@ references:
     orcid: https://orcid.org/0000-0002-7111-0077
   year: '2026'
   doi: 10.32614/CRAN.package.bslib
-  version: '>= 0.9.0'
+  version: '>= 0.10.0'
 - type: software
   title: colorspace
   abstract: 'colorspace: A Toolbox for Manipulating and Assessing Colors and Palettes'
@@ -385,7 +385,7 @@ references:
     orcid: https://orcid.org/0000-0002-9335-7468
   year: '2026'
   doi: 10.32614/CRAN.package.ggplot2
-  version: '>= 4.0.1'
+  version: '>= 4.0.2'
 - type: software
   title: ggimage
   abstract: 'ggimage: Use Image in ''ggplot2'''
@@ -614,7 +614,7 @@ references:
     email: hadley@rstudio.com
   year: '2026'
   doi: 10.32614/CRAN.package.tibble
-  version: '>= 3.3.0'
+  version: '>= 3.3.1'
 - type: software
   title: testthat
   abstract: 'testthat: Unit Testing for R'
@@ -627,5 +627,5 @@ references:
     email: hadley@posit.co
   year: '2026'
   doi: 10.32614/CRAN.package.testthat
-  version: '>= 3.3.1'
+  version: '>= 3.3.2'
 

DESCRIPTION

@@ -20,9 +20,9 @@ URL: https://danielvartan.github.io/logolink/,
 BugReports: https://github.com/danielvartan/logolink/issues/
 Depends: R (>= 4.4)
 Imports:
-    checkmate (>= 2.3.3),
+    checkmate (>= 2.3.4),
     cli (>= 3.6.5),
-    dplyr (>= 1.1.4),
+    dplyr (>= 1.2.0),
     fs (>= 1.6.6),
     glue (>= 1.8.0),
     janitor (>= 2.2.1),
@@ -31,13 +31,13 @@ Imports:
     readr (>= 2.1.6),
     tidyr (>= 1.3.2),
     stringr (>= 1.6.0),
-    xml2 (>= 1.5.1)
+    xml2 (>= 1.5.2)
 Suggests:
-    bslib (>= 0.9.0),
+    bslib (>= 0.10.0),
     colorspace (>= 2.1.2),
     covr (>= 3.6.5),
     curl (>= 7.0.0),
-    ggplot2 (>= 4.0.1),
+    ggplot2 (>= 4.0.2),
     ggimage (>= 0.3.5),
     ggtext (>= 0.1.2),
     here (>= 1.0.2),
@@ -51,8 +51,8 @@ Suggests:
     rsvg (>= 2.7.0),
     scales (>= 1.4.0),
     spelling (>= 2.3.2),
-    tibble (>= 3.3.0),
-    testthat (>= 3.3.1)
+    tibble (>= 3.3.1),
+    testthat (>= 3.3.2)
 SystemRequirements: NetLogo >= 7.0.1
 VignetteBuilder: quarto
 Config/testthat/edition: 3

README.md

@@ -5,6 +5,8 @@
 <!-- Install the package before rendering this file: `devtools::install()` -->
 
 <!-- badges: start -->
+[![Status at rOpenSci Software Peer
+Review](https://badges.ropensci.org/741_status.svg)](https://github.com/ropensci/software-review/issues/741)
 [![Project Status: Active - The project has reached a stable, usable
 state and is being actively
 developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
@@ -92,6 +94,10 @@ And the development version from [GitHub](https://github.com/) with:
 remotes::install_github("danielvartan/logolink")
 ```
 
+`logolink` do not install NetLogo itself. You will need to have NetLogo
+7.0.1 or higher installed on your computer to use this package. You can
+download it from the [NetLogo website](https://www.netlogo.org).
+
 ## Usage
 
 `logolink` usage is very straightforward. The main functions are:
@@ -236,7 +242,7 @@ library(dplyr)
 results |> glimpse()
 #> List of 2
 #>  $ metadata:List of 6
-#>   ..$ timestamp       : POSIXct[1:1], format: "2026-01-19 15:35:01"
+#>   ..$ timestamp       : POSIXct[1:1], format: "2026-02-11 12:46:59"
 #>   ..$ netlogo_version : chr "7.0.3"
 #>   ..$ output_version  : chr "2.0"
 #>   ..$ model_file      : chr "Wolf Sheep Simple 5.nlogox"
@@ -253,7 +259,7 @@ results |> glimpse()
 #>   ..$ energy_gain_from_sheep: num [1:110110] 5 5 5 5 5 5 5 5 5 5 ...
 #>   ..$ step                  : num [1:110110] 0 1 2 3 4 5 6 7 8 9 ...
 #>   ..$ count_wolves          : num [1:110110] 5 5 5 5 5 5 5 5 5 5 ...
-#>   ..$ count_sheep           : num [1:110110] 500 500 500 499 496 494 491 489 487 486 ...
+#>   ..$ count_sheep           : num [1:110110] 500 498 497 495 493 492 488 487 486 483 ...
 ```
 
 If you already have a file with experiment results, you can read it into
@@ -356,7 +362,7 @@ citation("logolink")
 [![](https://img.shields.io/badge/license-GPLv3-bd0000.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
 ``` text
-Copyright (C) 2025 Daniel Vartanian
+Copyright (C) 2026 Daniel Vartanian
 
 logolink is free software: you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software

README.qmd

@@ -31,6 +31,15 @@ source(here("R", ".setup.R"))
 #| warning: false
 
 cat(
+  paste0(
+    "[![",
+    "Status at rOpenSci Software Peer Review",
+    "](",
+    "https://badges.ropensci.org/741_status.svg",
+    ")](",
+    "https://github.com/ropensci/software-review/issues/741",
+    ")"
+  ),
   badge_repostatus("active"),
   paste0(
     "[![",
@@ -137,6 +146,8 @@ And the development version from [GitHub](https://github.com/) with:
 remotes::install_github("danielvartan/logolink")
 ```
 
+`logolink` do not install NetLogo itself. You will need to have NetLogo 7.0.1 or higher installed on your computer to use this package. You can download it from the [NetLogo website](https://www.netlogo.org).
+
 ## Usage
 
 `logolink` usage is very straightforward. The main functions are:
@@ -331,7 +342,7 @@ cat(
 ```
 
 ```text
-Copyright (C) 2025 Daniel Vartanian
+Copyright (C) 2026 Daniel Vartanian
 
 logolink is free software: you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software

codemeta.json

@@ -53,7 +53,7 @@
       "@type": "SoftwareApplication",
       "identifier": "bslib",
       "name": "bslib",
-      "version": ">= 0.9.0",
+      "version": ">= 0.10.0",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -105,7 +105,7 @@
       "@type": "SoftwareApplication",
       "identifier": "ggplot2",
       "name": "ggplot2",
-      "version": ">= 4.0.1",
+      "version": ">= 4.0.2",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -287,7 +287,7 @@
       "@type": "SoftwareApplication",
       "identifier": "tibble",
       "name": "tibble",
-      "version": ">= 3.3.0",
+      "version": ">= 3.3.1",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -300,7 +300,7 @@
       "@type": "SoftwareApplication",
       "identifier": "testthat",
       "name": "testthat",
-      "version": ">= 3.3.1",
+      "version": ">= 3.3.2",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -321,7 +321,7 @@
       "@type": "SoftwareApplication",
       "identifier": "checkmate",
       "name": "checkmate",
-      "version": ">= 2.3.3",
+      "version": ">= 2.3.4",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -347,7 +347,7 @@
       "@type": "SoftwareApplication",
       "identifier": "dplyr",
       "name": "dplyr",
-      "version": ">= 1.1.4",
+      "version": ">= 1.2.0",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -464,7 +464,7 @@
       "@type": "SoftwareApplication",
       "identifier": "xml2",
       "name": "xml2",
-      "version": ">= 1.5.1",
+      "version": ">= 1.5.2",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -475,7 +475,7 @@
     },
     "SystemRequirements": "NetLogo >= 7.0.1"
   },
-  "fileSize": "986.922KB",
+  "fileSize": "989.746KB",
   "citation": [
     {
       "@type": "CreativeWork",
@@ -500,5 +500,10 @@
   "readme": "https://github.com/danielvartan/logolink/blob/main/README.md",
   "contIntegration": ["https://github.com/danielvartan/logolink/actions", "https://github.com/danielvartan/logolink/actions", "https://app.codecov.io/gh/danielvartan/logolink"],
   "developmentStatus": "https://www.repostatus.org/#active",
+  "review": {
+    "@type": "Review",
+    "url": "https://github.com/ropensci/software-review/issues/741",
+    "provider": "https://ropensci.org"
+  },
   "keywords": ["agent-based-modeling", "apis", "behaviorspace", "complexity-science", "individual-based-modeling", "netlogo", "r-packages", "rstats", "simulations", "computational-science", "multi-agent-systems", "headless-execution", "computational-social-science", "data-science", "ecological-modeling", "environmental-modeling", "system-dynamics", "tidyverse"]
 }

man/figures/readme-wolf-sheep-model-plot-1-1.png

@@ -50,6 +50,8 @@ You can install `logolink` like any other R package, using the following command
 install.packages("logolink")
 ```
 
+`logolink` do not come with NetLogo, so make sure you have NetLogo installed on your computer. You can download it from the [NetLogo website](https://www.netlogo.org/download). `logolink` supports NetLogo version 7.0.1 and above.
+
 After installation, start by loading the package to access its functions:
 
 ```{r}