as_ecdf: Create An ECDF List

In jmlondon/wcUtils: Utilities to Access the Wildlife Computers Data Portal API

Create An ECDF List

Description

This creates a standardized list for holding ECDF data and sets the class to 'ecdf'. The S3 class, *wcECDF* consists of three named objects: 'type', 'percent_time', and 'ecdf'. The 'type' object is the same as that specified for the 'type' parameter. The 'percent_time' object holds the proportion of the summary period the tag spent within the 'shallow' or 'deep' portion of the water column. Lastly, the 'ecdf' object is a data.frame with a column, 'ecd_prop', that specifies the proportional values for the ECDF and a column, 'depth_break', that reports the corresponding depth value (in meters).

Usage

as_ecdf(type, ecdf)

Arguments

type	this is either 'shallow' or 'deep'
ecdf	a data.frame

Value

A list with three named objects ('type','percent_time','ecdf') of class 'wcECDF'

jmlondon/wcUtils documentation built on March 19, 2024, 8:40 a.m.