https://github.com/miraisolutions/godmode

Godmode package for R
https://github.com/miraisolutions/godmode

debugging hooks r testing testthat

Last synced: 3 months ago
JSON representation

Godmode package for R

• Host: GitHub
• URL: https://github.com/miraisolutions/godmode
• Owner: miraisolutions
• Created: 2017-06-27T13:09:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T14:42:06.000Z (4 months ago)
• Last Synced: 2024-07-17T17:48:04.281Z (4 months ago)
• Topics: debugging, hooks, r, testing, testthat
• Language: R
• Size: 889 KB
• Stars: 4
• Watchers: 6
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - miraisolutions/godmode - Godmode package for R (R)

README

        


# godmode

[![R-CMD-check](https://github.com/miraisolutions/godmode/actions/workflows/ci.yaml/badge.svg)](https://github.com/miraisolutions/godmode/actions/workflows/ci.yaml)

[![codecov](https://codecov.io/gh/miraisolutions/godmode/branch/master/graph/badge.svg)](https://codecov.io/gh/miraisolutions/godmode)

`Godmode` package for **R**

Provides alternative praise and encouragement, either in *god-mode* or *proverbs* mode.

Aims to provide more variety and fun in testing.

Also offers a set of unexported functions that can be useful for quick & dirty substitution of functions in namespaces of other packages, which for some people / teams / R-analytics-setups can help in accelerating proto-typing, testing of changes and debugging and ultimately time-to-production.

It is advised to get a good understanding of the base functions used in this part and their behavior, before attempting to make use of this elsewhere, in order to avoid undesired side effects and break-downs.

For related reasons, this package will quite certainly never make it to 

[![CRAN](http://www.r-pkg.org/badges/version/godmode)](https://cran.r-project.org/package=godmode) 

### Installation

Is meant to be used in conjunction with new version of `testthat`, which has been published to CRAN on 2017-12-13 (version 2.0.0).

Install with `remotes`:

```r

remotes::install_github("miraisolutions/godmode")

```

Or in case you would like to build the vignette as well:

```r

remotes::install_github("miraisolutions/godmode", build_opts = "")

```

### Getting started

To see an example for one possible way of how to use this package, best clone this repository into a new project inside RStudio and have a look at (i.e. read and try to run) `tests/testthat/test-stochModel.R`.

In case of proxy issues have a look at https://gist.github.com/evantoli/f8c23a37eb3558ab8765.

## Optional

If you like to play sounds, make sure to install the `audio` package from **CRAN**.

Then, in order to get something more fun than just a simple beep, you are free to replace the stub wave files in the external data sub-directory `inst/extdata` with some of your own music files, to which you own the license rights.

(The files should be named `Die.wav` and `GameOver.wav`, as to me the **Nintendo** sounds were the most befitting.)