From fe34c80b408fdfab9c4a08db5956ea2e74d9a304 Mon Sep 17 00:00:00 2001 From: hrbrmstr Date: Mon, 17 Jun 2019 21:02:36 -0400 Subject: [PATCH] readme --- R/stat-logspline.R | 2 +- README.Rmd | 2 ++ README.md | 7 +++++-- man/stat_logspline.Rd | 4 ++-- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/R/stat-logspline.R b/R/stat-logspline.R index 7087ce2..2775366 100644 --- a/R/stat-logspline.R +++ b/R/stat-logspline.R @@ -66,7 +66,7 @@ StatLogspline <- ggproto( ) -#' Computes and draws... +#' Computes logpline density (+ counts estimate), probability, survival & hazard #' #' @inheritParams ggplot2::stat_density #' @param n numbe of points for the density estimation (larger == smoother) diff --git a/README.Rmd b/README.Rmd index c0ce56f..202b6f2 100644 --- a/README.Rmd +++ b/README.Rmd @@ -26,6 +26,8 @@ Methods are provided to plot a logspline density, distribution function, hazard The following functions are implemented: +- `stat_logspline`: Computes logpline density (+ counts estimate), probability, survival & hazard + ## Installation ```{r install-ex, eval=FALSE} diff --git a/README.md b/README.md index 8e86627..d9f6048 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ hazard function or survival function from a logspline density The following functions are implemented: + - `stat_logspline`: Computes logpline density (+ counts estimate), + probability, survival & hazard + ## Installation ``` r @@ -96,8 +99,8 @@ ggplot(xdf) + | Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) | | :--- | -------: | --: | --: | ---: | ----------: | ---: | -------: | --: | -| R | 4 | 0.8 | 63 | 0.67 | 20 | 0.47 | 53 | 0.6 | -| Rmd | 1 | 0.2 | 31 | 0.33 | 23 | 0.53 | 35 | 0.4 | +| R | 4 | 0.8 | 63 | 0.67 | 20 | 0.45 | 53 | 0.6 | +| Rmd | 1 | 0.2 | 31 | 0.33 | 24 | 0.55 | 36 | 0.4 | ## Code of Conduct diff --git a/man/stat_logspline.Rd b/man/stat_logspline.Rd index c238112..fd7f5af 100644 --- a/man/stat_logspline.Rd +++ b/man/stat_logspline.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/stat-logspline.R \name{stat_logspline} \alias{stat_logspline} -\title{Computes and draws...} +\title{Computes logpline density (+ counts estimate), probability, survival & hazard} \usage{ stat_logspline(mapping = NULL, data = NULL, geom = "area", position = "identity", na.rm = FALSE, show.legend = NA, @@ -69,7 +69,7 @@ often aesthetics, used to set an aesthetic to a fixed value, like to the paired geom/stat.} } \description{ -Computes and draws... +Computes logpline density (+ counts estimate), probability, survival & hazard } \examples{ library(ggplot2)