-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
96 lines (71 loc) · 3.4 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
---
output: github_document
bibliography: vignettes/References.bib
---
<!-- *********** -->
<!-- Note: README.md is generated from README.Rmd. -->
<!-- Be sure to edit README.Rmd and generate the README.md file by Cmd/Ctl-shift-K -->
<!-- *********** -->
<!-- badges: start -->
[](https://cran.r-project.org/package=matsindf)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://www.repostatus.org/#active)
[](https://github.com/MatthewHeun/matsindf/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/MatthewHeun/matsindf?branch=master)
[](https://doi.org/10.5281/zenodo.5475443)
<!-- badges: end -->
# matsindf
## 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
You can install `matsindf` from CRAN with:
```{r CRAN-installation, eval = FALSE}
install.packages("matsindf")
```
You can install a recent development version of `matsindf` from github with:
```{r gh-installation, eval = FALSE}
# install devtools if not already installed
# install.packages("devtools")
devtools::install_github("MatthewHeun/matsindf")
# To build vignettes locally, use
devtools::install_github("MatthewHeun/matsindf", build_vignettes = TRUE)
```
## History
The functions in this package were used in
[Heun et al. [-@Heun:2018]](https://doi.org/10.1016/j.apenergy.2018.05.109).
## More Information
Find more information, including vignettes and function documentation, at
<https://MatthewHeun.github.io/matsindf/>.
## References