Skip to content

Commit

Permalink
Merge branch 'release-0.4.7'
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewHeun committed Dec 21, 2023
2 parents b0410c8 + c8b543e commit 6b5abd9
Show file tree
Hide file tree
Showing 34 changed files with 201 additions and 90 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Package: matsindf
Type: Package
Title: Matrices in Data Frames
Version: 0.4.6
Date: 2023-12-09
Version: 0.4.7
Date: 2023-12-20
Authors@R: c(person("Matthew", "Heun", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-7438-214X"),
email = "matthew.heun@me.com"))
Expand Down
10 changes: 9 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ Cite all releases with doi [10.5281/zenodo.5475443](https://doi.org/10.5281/zeno
which always resolves to the latest release.


# matsindf 0.4.6 (2023-12-09)
# matsindf 0.4.7 (2023-12-20)

* Added statement of need to README file.
* No new tests.
* Still at 377 tests, all passing.
* Test coverage remains at 100%.


# matsindf 0.4.6 (2023-12-09) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10340525.svg)](https://doi.org/10.5281/zenodo.10340525)

* Fix pkgdown website on GitHub.
* No new tests.
Expand Down
43 changes: 41 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,47 @@ bibliography: vignettes/References.bib

# matsindf

The `R` package `matsindf` provides
ways to interact with matrices in data frames.

## Statement of need

Matrices are important mathematical objects,
and they often describe networks of flows among nodes.
The power of matrices lies in their ability
to organize network-wide calculations,
thereby simplifying the work of analysts who study entire systems.

But [wouldn't it be nice](https://en.wikipedia.org/wiki/Wouldn%27t_It_Be_Nice)
if there were an easy way to create `R` data frames
whose entries were not numbers but entire matrices?
If that were possible,
matrix algebra could be performed on columns
of similar matrices.

That's the reason for `matsindf`.
It provides functions to convert
a suitably-formatted
[tidy](https://tidyr.tidyverse.org/articles/tidy-data.html)
data frame into a data frame containing a column of matrices.

Furthermore, `matsbyname` is a sister package that

* provides matrix algebra functions that respect names of matrix rows and columns
(`dimnames` in `R`)
to free the analyst from the task of aligning rows and columns of
operands (matrices) passed to matrix algebra functions and
* allows matrix algebra to be conducted within data frames using
[dplyr](https://dplyr.tidyverse.org),
[tidyr](https://tidyr.tidyverse.org),
and other
[tidyverse](https://www.tidyverse.org)
functions.

When used together, `matsindf` and `matsbyname`
allow analysts to wield simultaneously the power of both
[matrix mathematics](https://en.wikipedia.org/wiki/Matrix_(mathematics))
and
[tidyverse](https://www.tidyverse.org)
functional programming.


## Installation
Expand Down
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,39 @@ coverage](https://codecov.io/gh/MatthewHeun/matsindf/branch/master/graph/badge.s

# matsindf

The `R` package `matsindf` provides ways to interact with matrices in
data frames.
## Statement of need

Matrices are important mathematical objects, and they often describe
networks of flows among nodes. The power of matrices lies in their
ability to organize network-wide calculations, thereby simplifying the
work of analysts who study entire systems.

But [wouldn’t it be
nice](https://en.wikipedia.org/wiki/Wouldn%27t_It_Be_Nice) if there were
an easy way to create `R` data frames whose entries were not numbers but
entire matrices? If that were possible, matrix algebra could be
performed on columns of similar matrices.

That’s the reason for `matsindf`. It provides functions to convert a
suitably-formatted
[tidy](https://tidyr.tidyverse.org/articles/tidy-data.html) data frame
into a data frame containing a column of matrices.

Furthermore, `matsbyname` is a sister package that

- provides matrix algebra functions that respect names of matrix rows
and columns (`dimnames` in `R`) to free the analyst from the task of
aligning rows and columns of operands (matrices) passed to matrix
algebra functions and
- allows matrix algebra to be conducted within data frames using
[dplyr](https://dplyr.tidyverse.org),
[tidyr](https://tidyr.tidyverse.org), and other
[tidyverse](https://www.tidyverse.org) functions.

When used together, `matsindf` and `matsbyname` allow analysts to wield
simultaneously the power of both [matrix
mathematics](https://en.wikipedia.org/wiki/Matrix_(mathematics)) and
[tidyverse](https://www.tidyverse.org) functional programming.

## Installation

Expand Down
23 changes: 17 additions & 6 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
## Context

`matsindf` v0.4.6 fixes the `pkgdown` website on GitHub.
No other changes were made.
`matsindf` v0.4.7
adds a statement of need to the `README.Rmd` file
in preparation for submitting a paper to the
Journal of Open Source Software.
No other changes have been made.
See `NEWS.md` for details.


## Test environments (12 in total) and R CMD check results
Expand Down Expand Up @@ -40,7 +44,7 @@ No other changes were made.
* errors: 0
* warnings: 0
* notes: 0
* `devtools::check_win_devel()` R Under development (unstable) (2023-12-09 r85665 ucrt)
* `devtools::check_win_devel()` R Under development (unstable) (2023-12-20 r85713 ucrt)
* errors: 0
* warnings: 0
* notes: 0
Expand All @@ -67,10 +71,17 @@ No other changes were made.
* Fedora Linux, R-devel, clang, gfortran
* errors: 0
* warnings: 0
* notes: 1
* notes: 2
- checking HTML version of manual ... NOTE
- Skipping checking HTML validation: no command 'tidy' found
- The note appears only on Linux.
- Skipping checking HTML validation: no command 'tidy' found
- The note appears only on Linux.
- Checking CRAN incoming feasibility ... [10s/44s] NOTE
- Found the following (possibly) invalid URLs:
- Followed by a series of files with invalid URLs.
- I see no invalid URLs,
and Fedora Linux is the only platform where this
NOTE is provided.



## revdepcheck results
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

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

2 changes: 1 addition & 1 deletion 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 6b5abd9

Please sign in to comment.