Fix roxygen2 check note & Update README

.github/workflows/run_rhub.yaml

@@ -29,5 +29,5 @@ jobs:
 
       - name: Run checks
         run: |
-          nix-shell --run "Rscript -e \"rhub::rhub_check(platforms = c('linux','macos','macos-arm64','windows','ubuntu-next','ubuntu-release'))\""
+          nix-shell --run "Rscript -e \"rhub::rhub_check(platforms = c('linux','macos','macos-arm64','windows','ubuntu-next','ubuntu-release', 'gcc14'))\""
 

NEWS.md

@@ -2,7 +2,7 @@
 
 # rix 0.11.2 (2024-09-20)
 
-# Bug fixes
+## Bug fixes
 
 - fix `R CMD check` and `R CMD build` when running them in a `nix-shell --pure`
   development environment based on the `default.nix` of {rix} package root.

R/rix_helpers.R

@@ -131,8 +131,7 @@ get_rpkgs <- function(r_pkgs, ide) {
 #' correct Nix expression to get R packages.
 #' @param rPackages Character, list of R packages to install.
 #' @param flag_rpkgs Character, are there any R packages at all?
-#' @noRd
-#' # nolint start: object_name_linter
+#' @noRd # nolint start: object_name_linter
 generate_rpkgs <- function(rPackages, flag_rpkgs) {
   if (flag_rpkgs == "") {
     NULL
@@ -147,7 +146,7 @@ generate_rpkgs <- function(rPackages, flag_rpkgs) {
     )
   }
 }
-# nolint end: object_name_linter
+# nolint end
 
 #' generate_local_r_pkgs Internal function that generates the string containing
 #' the correct Nix expression for installing local packages

README.Rmd

@@ -42,13 +42,19 @@ Use cases include running web apps (e.g., Shiny, `{plumber}` APIs) or
 snapshots package versions, `{rix}` provides an entire ecosystem snapshot,
 including system-level dependencies.
 
-While Nix has a steep learning curve, `{rix}` simplifies creating Nix
-expressions, which define reproducible environments. You can work interactively
-in IDEs like RStudio or VS Code, or use Nix in CI/CD workflows. Nix includes
-nearly all CRAN and Bioconductor packages, with the ability to install specific
-package versions or GitHub snapshots. Nix also includes Python, Julia (and many
-of their respective packages) as well as many, many other tools (up to 100'000
-pieces of software as of writing).
+While Nix has a steep learning curve, `{rix}`
+
+1. simplifies creating Nix expressions, which define reproducible environments.
+2. lets you work interactively in IDEs like RStudio or VS Code, or use Nix in
+   CI/CD workflows.
+3. provides helpers that make it easy to build those environments, evaluate the
+   same code in different development environments, and finally to deploy
+   software environments in production.
+
+Nix includes nearly all CRAN advanced Bioconductor packages, with the ability to
+install specific package versions or GitHub snapshots. Nix also includes Python,
+Julia (and many of their respective packages) as well as many, many other tools
+(up to 100'000 pieces of software as of writing).
 
 
 If you have R installed, you can start straight away from your R session by
@@ -65,7 +71,6 @@ library("rix")
 Now try to generate an expression using `rix()`:
 
 ```{r, eval=FALSE}
-
 # Choose the path to your project
 # This will create two files: .Rprofile and default.nix
 path_default_nix <- "."

README.md

@@ -34,14 +34,21 @@ Use cases include running web apps (e.g., Shiny, `{plumber}` APIs) or
 which snapshots package versions, `{rix}` provides an entire ecosystem
 snapshot, including system-level dependencies.
 
-While Nix has a steep learning curve, `{rix}` simplifies creating Nix
-expressions, which define reproducible environments. You can work
-interactively in IDEs like RStudio or VS Code, or use Nix in CI/CD
-workflows. Nix includes nearly all CRAN and Bioconductor packages, with
-the ability to install specific package versions or GitHub snapshots.
-Nix also includes Python, Julia (and many of their respective packages)
-as well as many, many other tools (up to 100’000 pieces of software as
-of writing).
+While Nix has a steep learning curve, `{rix}`
+
+1.  simplifies creating Nix expressions, which define reproducible
+    environments.
+2.  lets you work interactively in IDEs like RStudio or VS Code, or use
+    Nix in CI/CD workflows.
+3.  provides helpers that make it easy to build those environments,
+    evaluate the same code in different development environments, and
+    finally to deploy software environments in production.
+
+Nix includes nearly all CRAN advanced Bioconductor packages, with the
+ability to install specific package versions or GitHub snapshots. Nix
+also includes Python, Julia (and many of their respective packages) as
+well as many, many other tools (up to 100’000 pieces of software as of
+writing).
 
 If you have R installed, you can start straight away from your R session
 by first installing `{rix}`:
@@ -57,7 +64,6 @@ library("rix")
 Now try to generate an expression using `rix()`:
 
 ``` r
-
 # Choose the path to your project
 # This will create two files: .Rprofile and default.nix
 path_default_nix <- "."
@@ -85,7 +91,9 @@ automatically by the main function, `rix()`.
 ## Quick Start for Returning Users
 
 <details>
+
 <summary>
+
 Click to expand
 </summary>