Skip to content

Commit

Permalink
chore: update vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
Ed2uiz committed Aug 14, 2024
1 parent e0daf24 commit f38e8cb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
6 changes: 6 additions & 0 deletions vignettes/arithmetic.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ library(dbMatrix)
```


## dbMatrix arithmetic

`dbMatrix` objects support `Arith` and `Ops` operations. We will demonstrate how to perform arithmetic operations on `dbSparseMatrix` objects.

**Note:** Some operations with zero values are not yet supported with dbMatrix objects. In addition, certain arithmetic operations between `dbMatrix` objects are also not yet supported. We welcome user feedback and reporting issues on the [Github page ](https://github.com/drieslab/dbMatrix/).

### Get test data
The test file is a `dgCMatrix`or compressed sparse column matrix representing a single cell gene expression matrix. The file is in the `data` directory of the package.

Expand Down
5 changes: 4 additions & 1 deletion vignettes/operations.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ library(Matrix)

## dbMatrix generics

`dbMatrix` subclasses currently support basic generic functions listed below with support for more operations coming soon.
`dbMatrix` objects currently support several statistical matrix operations listed below with support for more coming soon.

✅ - implemented
🟧 - not yet implemented

| | dbSparseMatrix | dbDenseMatrix |
|----------|----------------|---------------|
Expand Down

0 comments on commit f38e8cb

Please sign in to comment.