diff --git a/DESCRIPTION b/DESCRIPTION index deefc64..f7e8992 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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), diff --git a/R/craze-package.r b/R/craze-package.r index edadd7e..5c73a2d 100644 --- a/R/craze-package.r +++ b/R/craze-package.r @@ -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 diff --git a/README.md b/README.md index 55c7a4a..d972a31 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/man/craze-package.Rd b/man/craze-package.Rd index 5d80327..c9052d1 100644 --- a/man/craze-package.Rd +++ b/man/craze-package.Rd @@ -5,7 +5,9 @@ \alias{craze-package} \title{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'. } \author{ Drew Schmidt