oy_summary: Simple Summary Statistics of Oyster Journeys

Description Usage Arguments Value Examples

View source: R/summary.R

Description

Generate simple summaries of your Oyster journey history data for a quick overview.

Usage

1
oy_summary(data, mode = "Train")

Arguments

data

Data frame output from link{oy_clean()}.

mode

Currently restricted to "Train".

Value

A list object where each element is some kind of data summary.

Examples

1
2
3
4
5
6
## Not run: 
my_df <- oy_read("path/to/folder/")
my_df_clean <- oy_clean(my_df)
oy_summary(my_df_clean, mode = "Train")

## End(Not run)

matt-dray/oystr documentation built on Jan. 20, 2021, 6:43 a.m.