Merge pull request #87 from albersonmiranda/dev

docs: Update system requirements and imports

DESCRIPTION

@@ -29,7 +29,7 @@ Roxygen: list(markdown = TRUE, r6 = TRUE)
 RoxygenNote: 7.3.2
 Depends: 
     R (>= 4.0)
-SystemRequirements: Cargo (Rust's package manager), rustc >= 1.67.1
+SystemRequirements: Cargo (Rust's package manager), rustc >= 1.67.1, xz
 LazyData: true
 Imports: 
     cli,
@@ -40,7 +40,8 @@ Imports:
     readxl,
     rlang,
     shiny,
-    Rdpack
+    Rdpack,
+    R6
 License: MIT + file LICENSE
 Config/rextendr/version: 0.3.1.9000
 Suggests: 

NAMESPACE

@@ -2,5 +2,6 @@
 
 export(import_element)
 export(iom)
+import(R6)
 importFrom(Rdpack,reprompt)
 useDynLib(fio, .registration = TRUE)

R/addin.R

@@ -33,6 +33,7 @@ input_options <- shiny::selectInput(
 #'  where the data source is (either clipboard or Excel file) and import the
 #'  data into the global environment.
 #'  Appears as "Import input-output data" in the RStudio Addins menu.
+#' @references This function is based on the [reprex](https://github.com/tidyverse/reprex) package.
 
 fio_addin <- function() {
   rlang::check_installed(

R/r6.R

@@ -69,10 +69,11 @@
 #' )
 #'
 #' @importFrom Rdpack reprompt
+#' @import R6
 #' @export
 
 # input-output matrix class
-iom <- R6::R6Class(
+iom <- R6Class(
   classname = "iom",
   public = list(
     #' @field id (`character`)\cr

README.Rmd

@@ -31,18 +31,25 @@ The package is optimized for speed and efficiency. It leverages the [R6 class](h
 
 ## Installation
 
-You can install the released version of `{fio}` from CRAN with:
+### CRAN Release
+
+You can install the latest stable release of {fio} from CRAN with:
 
 ```r
 install.packages("fio")
 ```
-For the latest tested but unreleased version ([main branch](https://github.com/albersonmiranda/fio/tree/main)), you'll find precompiled binaries at [R-universe](https://albersonmiranda.r-universe.dev/fio):
+
+### Latest Tested version
+
+ install the latest tested but unreleased version from the [main branch](https://github.com/albersonmiranda/fio/tree/main), use the precompiled binaries available on [R-universe](https://albersonmiranda.r-universe.dev/fio):
 
 ```r
 install.packages("fio", repos = c("https://albersonmiranda.r-universe.dev", "https://cloud.r-project.org"))
 ```
 
-For the development version, you can compile the [dev branch](https://github.com/albersonmiranda/fio/tree/dev) from source, you'll need [Rust](https://www.rust-lang.org/) installed on your system. You can install Rust with the following commands:
+### Development version
+
+For the cutting-edge development version from the [dev branch](https://github.com/albersonmiranda/fio/tree/dev), you'll need to compile it from source. This requires [Rust](https://www.rust-lang.org/) to be installed on your system. You can install Rust using the following commands:
 
 - Debian/Ubuntu: `apt-get install cargo`
 - Fedora/CentOS: `dnf install cargo`

README.md

@@ -33,25 +33,32 @@ achieve highly optimized performance.
 
 ## Installation
 
-You can install the released version of `{fio}` from CRAN with:
+### CRAN Release
+
+You can install the latest stable release of {fio} from CRAN with:
 
 ``` r
 install.packages("fio")
 ```
 
-For the latest tested but unreleased version ([main
-branch](https://github.com/albersonmiranda/fio/tree/main)), you’ll find
-precompiled binaries at
+### Latest Tested version
+
+install the latest tested but unreleased version from the [main
+branch](https://github.com/albersonmiranda/fio/tree/main), use the
+precompiled binaries available on
 [R-universe](https://albersonmiranda.r-universe.dev/fio):
 
 ``` r
 install.packages("fio", repos = c("https://albersonmiranda.r-universe.dev", "https://cloud.r-project.org"))
 ```
 
-For the development version, you can compile the [dev
-branch](https://github.com/albersonmiranda/fio/tree/dev) from source,
-you’ll need [Rust](https://www.rust-lang.org/) installed on your system.
-You can install Rust with the following commands:
+### Development version
+
+For the cutting-edge development version from the [dev
+branch](https://github.com/albersonmiranda/fio/tree/dev), you’ll need to
+compile it from source. This requires [Rust](https://www.rust-lang.org/)
+to be installed on your system. You can install Rust using the following
+commands:
 
 - Debian/Ubuntu: `apt-get install cargo`
 - Fedora/CentOS: `dnf install cargo`

cran-comments.md

@@ -17,3 +17,5 @@ In this version I have:
     - Ubuntu 20.04, 22.04, 24.04; R release, devel and oldrel-1.
     - Fedora 36; R 4.2 built from source. `cargo` and other dependencies installed from Fedora 36 default repository (`dnf install`).
     - Fedora 37, 38, 39, 40; R and all dependencies installed from default repository (`dnf install`).
+* Added 'xz' to `SystemRequirements` for decompression of the vendored Rust dependencies.
+* Added 'R6' to `Imports` in `DESCRIPTION` as it is used in the package but for some reason it's absence didn't trigger a NOTE.