gglogspline/README.md

[![Travis-CI Build
Status](https://travis-ci.org/hrbrmstr/gglogspline.svg?branch=master)](https://travis-ci.org/hrbrmstr/gglogspline)
[![Coverage
Status](https://codecov.io/gh/hrbrmstr/gglogspline/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/gglogspline)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/gglogspline)](https://cran.r-project.org/package=gglogspline)

# gglogspline

A ‘ggplot2’ Extension for Visualizing Density, Distribution, Hazard, or
Survival Functions using the ‘logspline’ Package

## Description

Methods are provided to plot a logspline density, distribution function,
hazard function or survival function from a logspline density

## What’s Inside The Tin

The following functions are implemented:

  - `stat_logspline`: Computes logspline density (+ counts estimate),
    probability, survival & hazard

## Installation

``` r
install("gglogspline", repos = "https://cinc.rud.is")
# or
devtools::install_git("https://git.sr.ht/~hrbrmstr/gglogspline.git")
# or
devtools::install_git("https://git.rud.is/hrbrmstr/gglogspline.git")
# or
devtools::install_gitlab("hrbrmstr/gglogspline")
# or
devtools::install_bitbucket("hrbrmstr/gglogspline")
# or
devtools::install_github("hrbrmstr/gglogspline")
```

## Usage

``` r
library(gglogspline)
library(ggplot2)

# current version
packageVersion("gglogspline")
## [1] '0.1.0'
```

``` r
set.seed(1)
data.frame(
  val = rnorm(100)
) -> xdf

ggplot(xdf) + 
  stat_logspline(aes(val))
```

<img src="README_files/figure-gfm/unnamed-chunk-1-1.png" width="672" />

``` r

ggplot(xdf) + 
  stat_logspline(aes(val, y = stat(count))) +
  labs(title = "logspline (count)")
```

<img src="README_files/figure-gfm/unnamed-chunk-1-2.png" width="672" />

``` r

ggplot(xdf) +
  stat_logspline(aes(val, y = stat(probs))) +
  labs(title = "logspline (probability function)")
```

<img src="README_files/figure-gfm/unnamed-chunk-1-3.png" width="672" />

``` r

ggplot(xdf) +
  stat_logspline(aes(val, y = stat(survival))) +
  labs(title = "logspline (survival function)")
```

<img src="README_files/figure-gfm/unnamed-chunk-1-4.png" width="672" />

``` r

ggplot(xdf) +
  stat_logspline(aes(val, y = stat(hazard))) +
  labs(title = "logspline (hazard function)")
```

<img src="README_files/figure-gfm/unnamed-chunk-1-5.png" width="672" />

## gglogspline Metrics

| Lang | \# Files | (%) | LoC |  (%) | Blank lines |  (%) | \# Lines |  (%) |
| :--- | -------: | --: | --: | ---: | ----------: | ---: | -------: | ---: |
| R    |        4 | 0.8 |  63 | 0.66 |          20 | 0.45 |       53 | 0.59 |
| Rmd  |        1 | 0.2 |  32 | 0.34 |          24 | 0.55 |       37 | 0.41 |

## Code of Conduct

Please note that this project is released with a [Contributor Code of
Conduct](CONDUCT.md). By participating in this project you agree to
abide by its terms.