forge v0.2.0

0

Monthly downloads

0th

Percentile

Casting Values into Shape

Helper functions with a consistent interface to coerce and verify the types and shapes of values for input checking.

Readme

Travis build
statusCoverage
statusAppVeyor
build
status

forge

forge provides functions for input checking and casting. It is intended to be used by package developers, especially for interoperating with other runtimes, such as Python and JVM languages. It contains two families of functions, cast_* and certify(). The former casts a value to a specific type, while the latter ensures certain conditions are met.

Installation

You can install forge from CRAN with

install.packages("forge")

You can install the development version from GitHub with

devtools::install_github("rstudio/forge")

Examples

Here we demonstrate forge with a trivial function:

#' @import forge
fib <- function(n) {
  n <- cast_scalar_integer(n, return_id = TRUE) %>%
    certify(gte(0))

  if (n <= 2) {
    if( n >= 0) 1 else 0 
  } else {
    Recall(n - 1) + Recall(n - 2)
  }
}
fib(10)
#> [1] 55
fib(1.5)
#> Error: `n` cannot be casted to an integer vector.
fib(-2)
#> Error: Condition `gte(0)` not satisfied for `n`.

We can also provide arbitrary conditions to certify():

some_vec <- 1:5
certify(some_vec,  ~ any(.x < 2))
#> [1] 1 2 3 4 5
certify(some_vec, ~ mean(.x) > 2)
#> [1] 1 2 3 4 5
certify(some_vec, ~ all(.x <= 5), ~ mean(.x) > 3)
#> Error: Condition `~mean(.x) > 3` not satisfied for `some_vec`.

Please note that the ‘forge’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Functions in forge

Name Description
certify Ensure Conditions on a Value
cast Cast values into shape
%>% Pipe operator
No Results!

Last month downloads

Details

Type Package
License Apache License (>= 2.0)
Encoding UTF-8
LazyData true
RoxygenNote 6.1.0
NeedsCompilation no
Packaged 2019-02-26 15:41:55 UTC; kevinykuo
Repository CRAN
Date/Publication 2019-02-26 16:00:03 UTC

Include our badge in your README

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