Skip to content

Commit

Permalink
reorder cran vignettes, closes #33 (#34)
Browse files Browse the repository at this point in the history
* update titles of the two introduction vignettes

* rename vignettes to revise the order

* update NEWS
  • Loading branch information
rpahl authored Jan 5, 2025
1 parent a80c36e commit cfbf739
Show file tree
Hide file tree
Showing 70 changed files with 2,473 additions and 392 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# container (development version)

* rename vignettes to have desired order at CRAN (#33)
* update README and vignettes (#30)
* add News menu including this Changelog to package site
* link to other packges via [my R universe](https://rpahl.r-universe.dev/packages)
Expand Down
14 changes: 7 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ old <- options(width = 100L)
[![Code coverage](https://codecov.io/gh/rpahl/container/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rpahl/container)
[![R-CMD-check status](https://github.com/rpahl/container/workflows/R-CMD-check/badge.svg)](https://github.com/rpahl/container/actions)
[![Test coverage 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)
[![CRAN checks](https://badges.cranchecks.info/summary/container.svg)](https://cran.r-project.org/web/checks/check_results_v01-interactive-usage.html)
[![Downloads per month](https://cranlogs.r-pkg.org/badges/last-month/container)](https://cran.r-project.org/package=container)
[![Downloads total](https://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.svg)](https://github.com/rpahl/container/commits/master)
Expand All @@ -53,11 +53,11 @@ it easier and safer to work with list-like data structures.
* optional reference semantics

In addition, {container} provides specialized data structures
[Deque, Set, and Dict]( articles/deque-set-dict.html)
[Deque, Set, and Dict]( articles/v05-deque-set-dict.html)
and a *special* class `dict.table`, designed to extend
[data.table](https://CRAN.R-project.org/package=data.table) by
container operations to safely
[Manage data columns with dict.table](articles/manage-data-columns.html).
[Manage data columns with dict.table](articles/v04-manage-data-columns.html).


### Installation
Expand Down Expand Up @@ -128,10 +128,10 @@ co

### Get started

* [Introduction to container](articles/container.html)
* [Container operations for robust code](articles/code-development.html)
* [Manage parameter lists with dict](articles/parameter-list.html)
* [Manage data columns with dict.table](articles/manage-data-columns.html)
* [Use container in interactive session](articles/v01-interactive-usage.html)
* [Use container for code development](articles/v02-code-development.html)
* [Manage parameter lists with dict](articles/v03-parameter-list.html)
* [Manage data columns with dict.table](articles/v04-manage-data-columns.html)


### When *not* to use {container}
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ status](https://github.com/rpahl/container/workflows/R-CMD-check/badge.svg)](htt
[![Test coverage
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)
checks](https://badges.cranchecks.info/summary/container.svg)](https://cran.r-project.org/web/checks/check_results_v01-interactive-usage.html)
[![Downloads per
month](https://cranlogs.r-pkg.org/badges/last-month/container)](https://cran.r-project.org/package=container)
[![Downloads
Expand Down Expand Up @@ -43,11 +43,11 @@ that make it easier and safer to work with list-like data structures.
- optional reference semantics

In addition, {container} provides specialized data structures [Deque,
Set, and Dict](articles/deque-set-dict.html) and a *special* class
Set, and Dict](articles/v05-deque-set-dict.html) and a *special* class
`dict.table`, designed to extend
[data.table](https://CRAN.R-project.org/package=data.table) by container
operations to safely [Manage data columns with
dict.table](articles/manage-data-columns.html).
dict.table](articles/v04-manage-data-columns.html).

### Installation

Expand Down Expand Up @@ -128,11 +128,11 @@ co

### Get started

- [Introduction to container](articles/container.html)
- [Container operations for robust code](articles/code-development.html)
- [Manage parameter lists with dict](articles/parameter-list.html)
- [Use container in interactive session](articles/v01-interactive-usage.html)
- [Use container for code development](articles/v02-code-development.html)
- [Manage parameter lists with dict](articles/v03-parameter-list.html)
- [Manage data columns with
dict.table](articles/manage-data-columns.html)
dict.table](articles/v04-manage-data-columns.html)

### When *not* to use {container}

Expand Down
18 changes: 9 additions & 9 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ navbar:
aria-label: home
getStarted:
text: "Get Started"
href: articles/container.html
href: articles/v01-interactive-usage.html

articles:
text: "Articles"
Expand All @@ -133,20 +133,20 @@ navbar:
href: articles/index.html
- text: "---"
- text: "Get started"
- text: "Introduction to container"
href: articles/container.html
- text: "Container operations for robust code"
href: articles/code-development.html
- text: "Use container in interactive session"
href: articles/v01-interactive-usage.html
- text: "Use container for code development"
href: articles/v02-code-development.html
- text: "Manage parameter lists with dict"
href: articles/parameter-list.html
href: articles/v03-parameter-list.html
- text: "Manage data columns with dict.table"
href: articles/manage-data-columns.html
href: articles/v04-manage-data-columns.html
- text: "---"
- text: "Other"
- text: "Deque, Set, and Dict"
href: articles/deque-set-dict.html
href: articles/v05-deque-set-dict.html
- text: "Reference semantics"
href: articles/reference-semantics.html
href: articles/v06-reference-semantics.html

github:
icon: fab fa-github
Expand Down
14 changes: 7 additions & 7 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 16 additions & 16 deletions docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit cfbf739

Please sign in to comment.