Skip to content

Commit

Permalink
fix: all R CMD Check on local/remote/win and github release issue
Browse files Browse the repository at this point in the history
  • Loading branch information
soumyaray committed Nov 21, 2023
1 parent c597e96 commit 4482ff1
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 8 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
^\.Rproj\.user$
^README\.Rmd$
^\.github$
^cran-comments\.md$
15 changes: 9 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
Package: result
Title: Result Type for Operations that can Succeed or Fail
Version: 0.0.0.9000
Title: Result Type for Safely Handling Operations that can Succeed or Fail
Version: 0.1.0
Authors@R:
person("Soumya", "Ray", , "soumya.ray@gmail.com", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0002-7497-3281"))
Description: Allows wrapping values in `success()` and `failure()` types to capture
Description: Allows wrapping values in success() and failure() types to capture
the result of operations, along with any status codes. Risky expressions can be
wrapped in `as_result()` and functions wrapped in `result()` to catch errors
and assign the relevant result types. Monadic result objects can be bound together
in chains to gracefully handle errors in pipelines or transaction scripts.
wrapped in as_result() and functions wrapped in result() to catch errors
and assign the relevant result types. Monadic functions can be bound together
as pipelines or transaction scripts using then_try(), to gracefully handle
errors at any step.
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
License: MIT + file LICENSE
Suggests:
testthat (>= 3.0.0)
Config/testthat/edition: 3
URL: https://github.com/soumyaray/result
BugReports: https://github.com/soumyaray/result/issues
22 changes: 22 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# result (development version)

# result 0.1.0

* Initial CRAN submission.

## New Features

* Type functions
* success()
* failure()
* as_result()
* result()
* Pipline/Binding Functions
* bind() aliased to try_then()
* Attribute functions
* value()
* status()
* Predicate functions
* is_result()
* is_success()
* is_failure()
2 changes: 1 addition & 1 deletion R/attributes.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ value <- function(obj) UseMethod("value", obj)
#' @param obj \code{result} object
#' @return status of the \code{result}
#' @examples
#' status(success(42))
#' status(success("datafile.md", status = "created"))
#' @export
status <- function(obj) UseMethod("status", obj)

Expand Down
5 changes: 5 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ if (is_success(process)) {

## Installation

You can install the released version of result from CRAN:
``` r
install.packages("result")
```

You can install the development version of result from
[GitHub](https://github.com/soumyaray/result) with:

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ if (is_success(process)) {

## Installation

You can install the released version of result from CRAN:

``` r
install.packages("result")
```

You can install the development version of result from
[GitHub](https://github.com/soumyaray/result) with:

Expand Down
21 changes: 21 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Initial Submission (2023-11-21)

### R CMD check results (local)

`0 errors | 0 warnings | 1 note`

* This is a new release.

### R CMD check results (remote)

`0 errors | 0 warnings | 1 note`

* Note 1: "The Title field starts with the package name"
* The first word of the title is coincidentally the name of the package, because it refers to the Type after which the package is named.

### R CMD check results (remote Windows)

`0 errors | 0 warnings | 1 note`

* Note 1: "Possibly misspelled words in DESCRIPTION: Monadic (11:43)"
* This word should be correct, even if unusual
2 changes: 1 addition & 1 deletion man/status.Rd

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

0 comments on commit 4482ff1

Please sign in to comment.