Skip to content

Commit

Permalink
better package description
Browse files Browse the repository at this point in the history
  • Loading branch information
wrathematics committed May 30, 2020
1 parent f3a5cf7 commit f3d9b7e
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
6 changes: 4 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Package: craze
Type: Package
Title: Reference 'fmlr' Implementation
Title: Interface for 'fmlr'
Version: 0.2-0
Description: High-level, R-like interface for 'fmlr'.
Description: High-level, R-like interface for 'fmlr'. This gives a more
traditional, R-like interface around 'fmlr' functions and methods. The
package name is a play on the German word 'fimmel'.
License: BSL-1.0
Depends:
R (>= 3.6.0),
Expand Down
4 changes: 3 additions & 1 deletion R/craze-package.r
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
#' craze
#'
#' @description
#' High-level, R-like interface for fmlr.
#' High-level, R-like interface for fmlr. This gives a more
#' traditional, R-like interface around fmlr functions and methods. The
#' package name is a play on the German word 'fimmel'.
#'
#' @import fmlr
#' @import methods
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,18 @@

High-level, R-like interface for [fmlr](https://github.com/fml-fam/fmlr). The package name is a play on the German word 'fimmel' (fml, fimmel, ...).

The goal of the package is to give a move traditional R-like interface around fmlr functions and methods. It's basically just a shallow S4 wrapper. The canonical use case would be something like:
The goal of the package is to give a more traditional, R-like interface around fmlr functions and methods. It's basically just a shallow S4 wrapper. The canonical use case would be something like:

* build your matrix in R
* convert to an fmlr object via `as_cpumat()`, `as_gpumat()`, or `as_mpimat()` depending on what you want (may require a copy)
* convert to the craze `fmlmat` S4 object via `as_fmlmat()` (no copy)
* convert to an fmlr object:
- the easy way: use `fmlmat()`
- the harder, more robust way:
- convert the R matrix to an fmlr object via `as_cpumat()`, `as_gpumat()`, or `as_mpimat()` (may require a copy)
- convert to a craze `fmlmat` object via `as_fmlmat()` (no copy)
* call the desired linear algebra function(s)



## Installation

You will need an installation of [fmlr](https://github.com/fml-fam/fmlr). See the [fmlr installation guide](https://fml-fam.github.io/fmlr/html/articles/01-installation.html) for more details.
Expand Down
4 changes: 3 additions & 1 deletion man/craze-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f3d9b7e

Please sign in to comment.