Learn R Programming

rplanes

Introduction

The rplanes package (plausibility analysis of epidemiological signals) provides functionality to prepare data and analyze plausibility of both forecasted and reported epidemiological signals. The functions implement a set of plausibility algorithms that are agnostic to geographic and time resolutions and are calculated independently and then presented as a combined score.

Installation

The package is available to install from CRAN:

install.packages("rplanes")

Alternatively you can install the package from GitHub:

#install.packages("remotes")
remotes::install_github("signaturescience/rplanes", build_vignettes=TRUE)

Getting Started

The rplanes package includes vignettes describing package features in detail. To get started, refer to the “Basic Usage” vignette on the package website or in the R console:

vignette("basic-usage", package="rplanes")

Contributing

Please use GitHub issues to report bugs or request features. Contributions will be reviewed via pull requests.

Copy Link

Version

Install

install.packages('rplanes')

Monthly Downloads

205

Version

0.1.0

License

MIT + file LICENSE

Maintainer

VP Nagraj

Last Published

July 17th, 2024

Functions in rplanes (0.1.0)

valid_location

Validate location
to_signal

Create signal object
plane_trend

Trend component
resolve_resolution

Resolve resolution
read_forecast

Read in forecast file
to_chunk

Chunk a vector
seed_engine

Seed engine
rplanes-package

rplanes: Plausibility Analysis of Epidemiological Signals
rplanes_explorer

rplanes explorer app launcher
valid_dates

Validate dates
is_observed

Check observed
check_incomplete

Check completeness of seed and signal data
month_start

Month start
cutter

Cut into categorical differences
epiweek_start

Epiweek start
get_shapes

Determine shapes
create_sliding_windows_df

Sliding windows
%m-%

Month subtraction
is_forecast

Check forecast
plane_seed

Create seed
plane_repeat

Repeat component
plane_taper

Taper component
plane_diff

Difference component
plane_score

Score PLANES components
q_boundary

Quantile boundary
plane_cover

Coverage component
plane_zero

Zero component
%>%

Pipe operator
plane_shape

Shape component