Update pages to bootstrap 5 and github action pipelines (#26)

* upgrade to bootstrap 5 * update README * bump version in DESCRIPTION file and fix URLs * fix github link * add test-coverage badge * run github action pipelines for any branch * remove Date field * remove search bar * fix documentation signaled by CRAN devel checks
rpahl · Dec 2, 2024 · 2df2bbe · 2df2bbe
1 parent b47ef11
commit 2df2bbe
Show file tree

Hide file tree

Showing 250 changed files with 28,031 additions and 11,001 deletions.
diff --git a/.github/workflows/check-standard.yaml b/.github/workflows/check-standard.yaml
@@ -1,11 +1,6 @@
 # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
-on:
-  push:
-    branches: [main, master]
-  pull_request:
-    branches: [main, master]
-
+on: [push]
 name: R-CMD-check
 
 jobs:

diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -1,11 +1,6 @@
 # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
-on:
-  push:
-    branches: [main, master]
-  pull_request:
-    branches: [main, master]
-
+on: [push]
 name: test-coverage
 
 jobs:
@@ -28,11 +23,13 @@ jobs:
 
       - name: Test coverage
         run: |
+          Sys.setenv(R_CODECOV_ENV = "GITHUB_ACTION")
           covr::codecov(
             quiet = FALSE,
             clean = FALSE,
-            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
-          )
+            install_path = file.path(
+              normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
+            )
         shell: Rscript {0}
 
       - name: Show testthat output

diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ container.Rproj
 vignettes/*.html
 tags
 
+check
 /doc/
 /Meta/
 

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,7 @@
 Package: container
 Type: Package
 Title: Extending Base 'R' Lists
-Version: 1.0.4
-Date: 2022-12-11
+Version: 1.0.5
 Authors@R:
     person("Roman", "Pahl",
     email = "[email protected]", role = c("aut", "cre"))
@@ -24,7 +23,7 @@ Suggests:
     dplyr,
     tibble,
     testthat (>= 3.0.0)
-URL: https://rpahl.github.io/container/
+URL: https://rpahl.github.io/container/, https://github.com/rpahl/container
 BugReports: https://github.com/rpahl/container/issues
 NeedsCompilation: no
 Author: Roman Pahl [aut, cre]

diff --git a/R/0-dict.table.R b/R/0-dict.table.R
@@ -43,7 +43,7 @@
 #' @seealso [dict], [data.table](https://CRAN.R-project.org/package=data.table)
 #' @examples
 #' # Some basic examples using some typical data.table and dict operations.
-#' # The constructor can take the 'key' argument known from data.table():
+#' # The constructor can take the 'key' argument known from data.table:
 #' require(data.table)
 #' dit = dict.table(x = rep(c("b","a","c"), each = 3), y = c(1,3,6), key = "y")
 #' print(dit)
@@ -91,7 +91,7 @@ as.dict.table <- function(x, ...)
 }
 
 #' @rdname dict.table
-#' @param copy if `TRUE` creates a copy of the [data.table] object otherwise
+#' @param copy if `TRUE` creates a copy of the `data.table` object otherwise
 #' works on the passed object by reference.
 #' @examples
 #'

diff --git a/R/container-deprecated.R b/R/container-deprecated.R
@@ -5,7 +5,7 @@
 #' @param x any `R` object.
 #' @details
 #' * [empty()]      [is_empty()] instead
-#' * [set()]        [setnew()] instead
+#' * `set`          [setnew()] instead
 #' * [size()]       use [length()] instead
 #' * [sortkey()]    keys of [Dict] objects are now always sorted
 #' * [remove()]     use [delete()] instead

diff --git a/README.Rmd b/README.Rmd
@@ -6,6 +6,7 @@ output: github_document
 
 ```{r, include = FALSE}
 require(container)
+require(badger)
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#",
@@ -21,18 +22,20 @@ old <- options(width = 100L)
 
 <!-- badges: start -->
 
-[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/container)](https://cran.r-project.org/package=container)
-[![dependencies](https://tinyverse.netlify.com/badge/container)](https://CRAN.R-project.org/package=container)
-[![codecov.io](https://codecov.io/github/rpahl/container/coverage.svg?branch=master)](https://codecov.io/github/rpahl/container?branch=master)
-[![R-CMD-check](https://github.com/rpahl/container/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/rpahl/container/actions/workflows/check-standard.yaml)
-[![downloads](https://cranlogs.r-pkg.org/badges/container?color=3aa9e8)](https://www.r-pkg.org:443/pkg/container)
-[![total-downloads](http://cranlogs.r-pkg.org/badges/grand-total/container)](https://cran.r-project.org/package=container)
-[![last-commit](https://img.shields.io/github/last-commit/rpahl/container)](https://cran.r-project.org/package=container)
-[![Lifecycle_Badge](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://cran.r-project.org/package=container)
+`r badge_cran_release()`
+[![dependencies](https://tinyverse.netlify.app/badge/container)](https://CRAN.R-project.org/package=container)
+`r badge_codecov(branch = "master")`
+`r badge_github_actions(action = "R-CMD-check")`
+`r badge_github_actions(action = "test-coverage")`
+`r badge_cran_checks()`
+`r badge_cran_download("container", "last-month")`
+`r badge_cran_download("container", "grand-total")`
+`r badge_last_commit()`
+`r badge_lifecycle("stable")`
 
 <!-- badges: end -->
 
-# container <img src="man/figures/logo.png" align="right" width="163" height="104"/>
+# container <img src="man/figures/logo.png" alt="logo" align="right" width="163" height="104"/>
 
 `container` provides an enhanced version of base R's `list` with a
 carefully designed set of extract, replace, and remove operations that make

diff --git a/README.md b/README.md
@@ -1,32 +1,38 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
+
 <!-- badges: start -->
 
-[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/container)](https://cran.r-project.org/package=container)
-[![dependencies](https://tinyverse.netlify.com/badge/container)](https://CRAN.R-project.org/package=container)
-[![codecov.io](https://codecov.io/github/rpahl/container/coverage.svg?branch=master)](https://codecov.io/github/rpahl/container?branch=master)
-[![R-CMD-check](https://github.com/rpahl/container/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/rpahl/container/actions/workflows/check-standard.yaml)
-[![downloads](https://cranlogs.r-pkg.org/badges/container?color=3aa9e8)](https://www.r-pkg.org:443/pkg/container)
-[![total-downloads](http://cranlogs.r-pkg.org/badges/grand-total/container)](https://cran.r-project.org/package=container)
-[![last-commit](https://img.shields.io/github/last-commit/rpahl/container)](https://cran.r-project.org/package=container)
-[![Lifecycle_Badge](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://cran.r-project.org/package=container)
+[![](https://www.r-pkg.org/badges/version/container)](https://cran.r-project.org/package=container)
+[![dependencies](https://tinyverse.netlify.app/badge/container)](https://CRAN.R-project.org/package=container)
+[![](https://codecov.io/gh/rpahl/container/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rpahl/container)
+[![R build
+status](https://github.com/rpahl/container/workflows/R-CMD-check/badge.svg)](https://github.com/rpahl/container/actions)
+[![R build
+status](https://github.com/rpahl/container/workflows/test-coverage/badge.svg)](https://github.com/rpahl/container/actions)
+[![CRAN
+checks](https://badges.cranchecks.info/summary/container.svg)](https://cran.r-project.org/web/checks/check_results_container.html)
+[![](http://cranlogs.r-pkg.org/badges/last-month/container)](https://cran.r-project.org/package=container)
+[![](http://cranlogs.r-pkg.org/badges/grand-total/container)](https://cran.r-project.org/package=container)
+[![](https://img.shields.io/github/last-commit/rpahl/container.svg)](https://github.com/rpahl/container/commits/master)
+[![](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 
 <!-- badges: end -->
 
-# container <img src="man/figures/logo.png" align="right" width="163" height="104"/>
+# container <img src="man/figures/logo.png" alt="logo" align="right" width="163" height="104"/>
 
 `container` provides an enhanced version of base R’s `list` with a
 carefully designed set of extract, replace, and remove operations that
 make it easier and safer to work with list-like data structures.
 
 ### Why `container`?
 
--   safe and flexible operations to
-    -   extract (built-in default values, no unintended `NULL`)
-    -   add and replace (mixed indices, no unintended overrides)
-    -   remove (loose or strict deletion, remove by index or value)
--   compact printing
--   optional reference semantics
+- safe and flexible operations to
+  - extract (built-in default values, no unintended `NULL`)
+  - add and replace (mixed indices, no unintended overrides)
+  - remove (loose or strict deletion, remove by index or value)
+- compact printing
+- optional reference semantics
 
 In addition, this package provides specialized data structures *Deque*,
 *Set* and *Dict* and a *special* class `dict.table`, designed to extend
@@ -100,11 +106,11 @@ co
 
 ### Getting Started
 
--   [Introduction to
-    container](https://rpahl.github.io/container/articles/container.html)
--   [Container operations for robust
-    code](https://rpahl.github.io/container/articles/code-development.html)
--   [Manage parameter lists with
-    dict](https://rpahl.github.io/container/articles/parameter-list.html)
--   [Manage data columns with
-    dict.table](https://rpahl.github.io/container/articles/manage-data-columns.html)
+- [Introduction to
+  container](https://rpahl.github.io/container/articles/container.html)
+- [Container operations for robust
+  code](https://rpahl.github.io/container/articles/code-development.html)
+- [Manage parameter lists with
+  dict](https://rpahl.github.io/container/articles/parameter-list.html)
+- [Manage data columns with
+  dict.table](https://rpahl.github.io/container/articles/manage-data-columns.html)
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -2,13 +2,19 @@ url: https://github.com/rpahl/container
 
 
 template:
-  params:
-    bootswatch: cerulean
+  bootstrap: 5
+  bootswatch: cerulean
 
 authors:
   Roman Pahl:
     href: https://rpahl.github.io/r-some-blog/about.html
 
+home:
+  links:
+  - text: Visit my R blog
+    href: https://rpahl.github.io/r-some-blog/
+
+
 reference:
   - title: "Container"
     desc: "A container can be considered a base R list with extended functionality."
@@ -111,31 +117,28 @@ articles:
     - reference-semantics
 
 
-home:
-  links:
-  - text: Visit my R blog
-    href: https://rpahl.github.io/r-some-blog/
-
 
 navbar:
-  title: "container"
-  left:
-    - icon: fa-home fa-lg
+  structure:
+    left: [home, getStarted, reference, articles, myPackages]
+    right: [github, stackoverflow, bluesky, blog]
+
+  components:
+    home:
+      icon: fa-home fa-lg
       href: index.html
-    - text: "Get started"
-      href: articles/container.html
-    - text: "Reference"
-      href: reference/index.html
-    - text: "Changelog"
-      href: news/index.html
-    - text: "Articles"
+      aria-label: home
+    getStarted:
+      text: "Get Started"
+      href: articles/get-started.html
+
+    articles:
+      text: "Articles"
       menu:
-        - title: "Overview"
         - text: "Overview"
           href: articles/index.html
-
         - text: "---"
-        - text: "Get started"  
+        - text: "Get started"
         - text: "Introduction to container"
           href: articles/container.html
         - text: "Container operations for robust code"
@@ -144,25 +147,36 @@ navbar:
           href: articles/parameter-list.html
         - text: "Manage data columns with dict.table"
           href: articles/manage-data-columns.html
-
-        - text: "---"  
+        - text: "---"
         - text: "Other"
         - text: "Deque, Set, and Dict"
           href: articles/deque-set-dict.html
         - text: "Reference semantics"
           href: articles/reference-semantics.html
-    - text: "My packages"
+
+    myPackages:
+      text: "My Packages"
       menu:
-        - text: "container"
-          href: https://rpahl.github.io/container/
-        - text: "GroupSeq"
-          href: https://rpahl.github.io/GroupSeq/
-  right:
-    - icon: fab fa-github
+      - text: "container"
+        href: https://rpahl.github.io/container/
+      - text: "GroupSeq"
+        href: https://rpahl.github.io/GroupSeq/
+      - text: "pipeflow"
+        href: https://rpahl.github.io/pipeflow/
+
+    github:
+      icon: fab fa-github
       href: https://github.com/rpahl/container/
-    - icon: fab fa-stack-overflow
+      aria-label: github
+    stackoverflow:
+      icon: fab fa-stack-overflow
       href: https://stackoverflow.com/users/8120617/rpahl
-    - icon: fab fa-twitter
-      href: https://twitter.com/romanpahl
-    - icon: fas fa-blog
+      aria-label: stackoverflow
+    bluesky:
+      icon: fab fa-bluesky
+      href: https://bsky.app/profile/rpahl.bsky.social
+      aria-label: bluesky
+    blog:
+      icon: fas fa-blog
       href: https://rpahl.github.io/r-some-blog/
+      aria-label: blog
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ container.Rproj @@
     vignettes/*.html
     tags
+    check
     /doc/
     /Meta/
@@ Expand Down @@