version 0.4.7

DESCRIPTION

@@ -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"))
@@ -25,7 +25,7 @@ URL: https://github.com/MatthewHeun/matsindf,
         https://matthewheun.github.io/matsindf/
 BugReports: https://github.com/MatthewHeun/matsindf/issues
 NeedsCompilation: no
-Packaged: 2023-12-10 02:12:28 UTC; mkh2
+Packaged: 2023-12-21 13:21:39 UTC; mkh2
 Author: Matthew Heun [aut, cre] (<https://orcid.org/0000-0002-7438-214X>)
 Repository: CRAN
-Date/Publication: 2023-12-10 03:20:03 UTC
+Date/Publication: 2023-12-21 13:40:02 UTC

MD5

@@ -1,7 +1,7 @@
-7ad373f1b1599a706cddd3e1f0c6b0ba *DESCRIPTION
+e22a6c159af3f12dcbe99632dd437ada *DESCRIPTION
 802cb51ae1e43f016c9cfc7f48dcdd17 *LICENSE
 f9ca5a70cd085381e1e4f0382f7c3816 *NAMESPACE
-901e4b2fc27fa07d7c22ce5071f43c08 *NEWS.md
+b64bddbdeb22db235d13737945a74b37 *NEWS.md
 1fa814428f24f3414cda07fe981bf3d9 *R/collapse.R
 ec2122278b8840558f1d32429d82a142 *R/data.R
 a22f6793a7b7c34108398b3f49594f87 *R/expand.R
@@ -10,21 +10,21 @@ a22f6793a7b7c34108398b3f49594f87 *R/expand.R
 e3702e4a4f1c2f263d84afd1e53f185c *R/utils-.data.R
 15355d49503b97b502d614bc1629aefa *R/utils-pipe.R
 f60225411bc1570c427e39238dc2c8c2 *R/utils-qqassign.R
-d292f2659b90a15ea241a8eb44225cba *README.md
+a470056be5ee93d0ada9798b8b298386 *README.md
 8faf250d78a120ba4c7ea2186efddd24 *build/partial.rdb
 6ee974d049d14c03a36f86fe53e79386 *build/vignette.rds
 8e890f45eea6929749a53f5c49db8d80 *data/UKEnergy2000.rda
-57e974cec02d98f136ace1c83b6a7dd1 *inst/CITATION
+375e641c2fb7fcf1ecded52f06533aad *inst/CITATION
 0427de01a64de2faf2e155cd7157fe0d *inst/WORDLIST
 67290c7a98151608e10508a579801e13 *inst/doc/iris_pca.R
 7cd37ad63ba95504eccda7762e1ba3aa *inst/doc/iris_pca.Rmd
-ea5a449900b3a00bad674c8a6cae287e *inst/doc/iris_pca.html
+dc05c75ecf91b21ce757e0420350d9d6 *inst/doc/iris_pca.html
 b8f3238dd698f8d8d8a4d1390cc34943 *inst/doc/matsindf.R
-8de8f415d1524736445aad1aee1f2257 *inst/doc/matsindf.Rmd
-349a815cd39c3040aa91edbbcc02b78c *inst/doc/matsindf.html
+1e901bd131b1687745e73b1bce941e81 *inst/doc/matsindf.Rmd
+412d4a1e189238074034035c1ed6a77c *inst/doc/matsindf.html
 4e18bc67225071dd189227cc38daa478 *inst/doc/midf_apply_primer.R
 6abb00bf7b1a90a6cebc9184fbcc5001 *inst/doc/midf_apply_primer.Rmd
-150282c80d149aeeb78800a33208bac7 *inst/doc/midf_apply_primer.html
+4347daf93289369924d9156290d391d4 *inst/doc/midf_apply_primer.html
 24627d4f6f4d8d302fa5b0d163cb023c *man/UKEnergy2000.Rd
 9efef69d4592fa064023ef08607fcf94 *man/add_UKEnergy2000_matnames.Rd
 2b3b543bfe8cbc20a65a4b37c6c342c4 *man/add_UKEnergy2000_row_col_meta.Rd
@@ -60,5 +60,5 @@ db23fc7d13fae8292a0fee38c3e2b1c2 *tests/testthat/test-expand.R
 50ad861aa44d86043bc2b4a1b3bbe88f *tests/testthat/test-utilities.R
 41d243a4d4106763cb78f7924490c205 *vignettes/References.bib
 7cd37ad63ba95504eccda7762e1ba3aa *vignettes/iris_pca.Rmd
-8de8f415d1524736445aad1aee1f2257 *vignettes/matsindf.Rmd
+1e901bd131b1687745e73b1bce941e81 *vignettes/matsindf.Rmd
 6abb00bf7b1a90a6cebc9184fbcc5001 *vignettes/midf_apply_primer.Rmd

NEWS.md

@@ -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.

README.md

@@ -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
 

inst/CITATION

@@ -8,10 +8,10 @@ bibentry(
                        role = c("aut", "cre"),
                        comment = c(ORCID = "0000-0002-7438-214X")),
   year        = "2023",
-  note        = "R package version 0.4.6",
+  note        = "R package version 0.4.7",
   url         = "https://doi.org/10.5281/zenodo.5475443",
   textVersion = paste("Matthew Kuperus Heun (2023).",
                       "matsindf: Matrices in Data Frames",
-                      "R package version 0.4.6",
+                      "R package version 0.4.7",
                       "https://doi.org/10.5281/zenodo.5475443")
 )

inst/doc/iris_pca.html

@@ -12,7 +12,7 @@
 
 <meta name="author" content="Alexander Davis" />
 
-<meta name="date" content="2023-12-09" />
+<meta name="date" content="2023-12-21" />
 
 <title>Using matsindf for principal components analysis</title>
 
@@ -341,7 +341,7 @@
 <h1 class="title toc-ignore">Using matsindf for principal components
 analysis</h1>
 <h4 class="author">Alexander Davis</h4>
-<h4 class="date">2023-12-09</h4>
+<h4 class="date">2023-12-21</h4>
 
 
 

inst/doc/matsindf.Rmd

@@ -55,7 +55,7 @@ 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 data frames
+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
@@ -67,13 +67,13 @@ 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 ...
+Furthermore, `matsbyname` is a sister package that
 
-* ... provides matrix algebra functions that respect names of matrix rows and columns
+* 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 
+* allows matrix algebra to be conducted within data frames using 
 [dplyr](https://dplyr.tidyverse.org),
 [tidyr](https://tidyr.tidyverse.org), 
 and other

inst/doc/matsindf.html

@@ -12,7 +12,7 @@
 
 <meta name="author" content="Matthew Kuperus Heun" />
 
-<meta name="date" content="2023-12-09" />
+<meta name="date" content="2023-12-21" />
 
 <title>Use Cases and Examples for matsindf</title>
 
@@ -362,7 +362,7 @@
 
 <h1 class="title toc-ignore">Use Cases and Examples for matsindf</h1>
 <h4 class="author">Matthew Kuperus Heun</h4>
-<h4 class="date">2023-12-09</h4>
+<h4 class="date">2023-12-21</h4>
 
 
 
@@ -402,19 +402,20 @@ <h2>Introduction</h2>
 calculations, thereby simplifying the work of analysts who study entire
 systems.</p>
 <p>But <a href="https://en.wikipedia.org/wiki/Wouldn%27t_It_Be_Nice">wouldn’t it
-be nice</a> if there were an easy way to create data frames whose
-entries were not numbers but entire matrices? If that were possible,
-matrix algebra could be performed on columns of similar matrices.</p>
+be nice</a> if there were an easy way to create <code>R</code> data
+frames whose entries were not numbers but entire matrices? If that were
+possible, matrix algebra could be performed on columns of similar
+matrices.</p>
 <p>That’s the reason for <code>matsindf</code>. It provides functions to
 convert a suitably-formatted <a href="https://tidyr.tidyverse.org/articles/tidy-data.html">tidy</a> data
 frame into a data frame containing a column of matrices.</p>
-<p>Furthermore, <code>matsbyname</code> is a sister package that …</p>
+<p>Furthermore, <code>matsbyname</code> is a sister package that</p>
 <ul>
-<li>… provides matrix algebra functions that respect names of matrix
-rows and columns (<code>dimnames</code> in <code>R</code>) to free the
+<li>provides matrix algebra functions that respect names of matrix rows
+and columns (<code>dimnames</code> in <code>R</code>) to free the
 analyst from the task of aligning rows and columns of operands
 (matrices) passed to matrix algebra functions and</li>
-<li>… allows matrix algebra to be conducted within data frames using <a href="https://dplyr.tidyverse.org">dplyr</a>, <a href="https://tidyr.tidyverse.org">tidyr</a>, and other <a href="https://www.tidyverse.org">tidyverse</a> functions.</li>
+<li>allows matrix algebra to be conducted within data frames using <a href="https://dplyr.tidyverse.org">dplyr</a>, <a href="https://tidyr.tidyverse.org">tidyr</a>, and other <a href="https://www.tidyverse.org">tidyverse</a> functions.</li>
 </ul>
 <p>When used together, <code>matsindf</code> and <code>matsbyname</code>
 allow analysts to wield simultaneously the power of both <a href="https://en.wikipedia.org/wiki/Matrix_(mathematics)">matrix

inst/doc/midf_apply_primer.html

@@ -12,7 +12,7 @@
 
 <meta name="author" content="Matthew Kuperus Heun" />
 
-<meta name="date" content="2023-12-09" />
+<meta name="date" content="2023-12-21" />
 
 <title>A matsindf_apply primer</title>
 
@@ -340,7 +340,7 @@
 
 <h1 class="title toc-ignore">A matsindf_apply primer</h1>
 <h4 class="author">Matthew Kuperus Heun</h4>
-<h4 class="date">2023-12-09</h4>
+<h4 class="date">2023-12-21</h4>
 
 
 

vignettes/matsindf.Rmd

@@ -55,7 +55,7 @@ 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 data frames
+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
@@ -67,13 +67,13 @@ 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 ...
+Furthermore, `matsbyname` is a sister package that
 
-* ... provides matrix algebra functions that respect names of matrix rows and columns
+* 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 
+* allows matrix algebra to be conducted within data frames using 
 [dplyr](https://dplyr.tidyverse.org),
 [tidyr](https://tidyr.tidyverse.org), 
 and other