README.md

diagonals

License CRAN Version RStudio Cloud Downloads Travis-CI Build Status Coverage Status

Block-diagonal matrices can be extracted or removed using two small functions implemented here, in addition, non-square matrices are supported.

Block diagonal matrices occur when we combine two dimensions of a data set along one edge of a matrix. For example, trade-flow data in the decompr and gvc package have each country-industry combination occur on each edge of the matrix.

Installation

The stable version of the diagonals package can be install from CRAN using:

install.packages("diagonals")

The development version, to be used at your peril, can be installed using:

if (!require('devtools')) install.packages('devtools')
devtools::install_github("bquast/diagonals")

Usage

Following installation, the package can be loaded using:

library(diagonals)

For general information on using the package, please refer to the help files .

help("diagonals")
help(package = "diagonals")

For examples of usage, see the function specific help page.

help("fatdiag")

In addition to the help files we provide long form examples in the vignettes .

vignette("fatdiag")

# or
browseVignettes("diagonals")

Additional Information

An overview of the changes is available in the NEWS file.

news(package="diagonals")

There is also a blog post with information on my personal website.

http://qua.st/diagonals/

Development

Development takes place on the GitHub page.

https://github.com/bquast/diagonals

Bugs can be filed on the issues page on GitHub.

https://github.com/bquast/diagonals/issues



bquast/diagonals documentation built on May 11, 2017, 3:32 p.m.