assertive.matrices v0.0-2

0

Monthly downloads

0th

Percentile

Assertions to Check Properties of Matrices

A set of predicates and assertions for checking the properties of matrices. This is mainly for use by other package developers who want to include run-time testing features in their own packages. End-users will usually want to use assertive directly.

Readme

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Is the package on CRAN? SemaphoreCI Build Status AppVeyor Build Status Research software impact

assertive.matrices

A set of predicates and assertions for checking the properties of matrices. Most of the documentation is on the assertive page. End-users will usually want to use assertive directly.

Installation

To install the stable version, type:

install.packages("assertive.matrices")

To install the development version, you first need the devtools package.

install.packages("devtools")

Then you can install the assertive.matrices package using

library(devtools)
install_bitbucket("richierocks/assertive.matrices")

Predicates

is_identity_matrix, is_diagonal_matrix, is_symmetric_matrix, is_lower_triangular_matrix, is_upper_triangular_matrix, is_square_matrix and is_zero_matrix checks whether a variable is a matrix with suitable properties.

Assertions

Predicates all return a single logical value and have one corresponding assertion. For example, is_symmetric_matrix has assert_is_symmetric_matrix.

Functions in assertive.matrices

Name Description
assert_is_zero_matrix Is the input a zero matrix
assert_is_symmetric_matrix Is the input a symmetric matrix?
assert_is_lower_triangular_matrix Is the matrix upper/lower triangular?
assert_is_square_matrix Is the matrix a square matrix?
assert_is_diagonal_matrix Is the input a diagonal matrix?
assert_is_identity_matrix Is the matrix an identity matrix?
No Results!

Last month downloads

Details

Type Package
Date 2018-11-20
URL https://bitbucket.org/richierocks/assertive.matrices
BugReports https://bitbucket.org/richierocks/assertive.matrices/issues
License GPL (>= 3)
LazyLoad yes
LazyData yes
Acknowledgments Development of this package was partially funded by the Proteomics Core at Weill Cornell Medical College in Qatar . The Core is supported by 'Biomedical Research Program' funds, a program funded by Qatar Foundation.
Collate 'imports.R' 'assert-is-matrix.R' 'is-matrix.R'
RoxygenNote 6.1.0
NeedsCompilation no
Packaged 2018-11-20 17:42:49 UTC; richierocks
Repository CRAN
Date/Publication 2018-11-20 18:10:03 UTC
imports assertive.base (>= 0.0-2)
depends R (>= 3.0.0)
suggests testthat
Contributors

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/assertive.matrices)](http://www.rdocumentation.org/packages/assertive.matrices)