as_Proxyzoo.zoo: Convert one (two) zoo::zoo objects to one...

In paleovar/ptboxproxydata: The Proxy Data Manager for a consistent, efficient and reusable data workflow for (paleo) time series within the PaleoToolBox (PTBox)

Convert one (two) zoo::zoo objects to one PTBoxProxydata::Proxyzoo

Description

Convert one (two) zoo::zoo objects to one PTBoxProxydata::Proxyzoo

Usage

## S3 method for class 'zoo'
as_Proxyzoo(proxyzoo, agezoo = NULL, indexcol = "index")

Arguments

proxyzoo	'zoo::zoo', contains proxy data (see *Details* for expected formatting)
agezoo	'zoo::zoo', optional contains age/age model data (see *Details* for expected formatting)
indexcol

Details

Expects proxy data 'proxyzoo' either with a column named 'depth' or 'age' which can be used as an index (unless names are specified otherwise in the configuration of the 'PTBoxProxydata' package), or tries to use the first column of the 'proxyzoo' 'zoo::zoo' object. If 'zoo::zoo' object 'agezoo' is supplied additionally, expects matching 'depth', 'age' or first indexing column.

If both 'depth' and 'age' are contained in 'proxyzoo', 'depth' will be used as *unambiguous* index, and 'age' will be included in 'Proxyzoo$agedata'.

If only 'age' is provided as index, this *can* (does not have to) lead to *ambigious* indexing of the data in case that a hiatus is present in the data.

If none of 'depth' or 'age' are provided, returned 'Proxyzoo$agedata' will only consist of an '$index'/'index()' column linking to 'Proxyzoo$agedata' (see Proxyzoo for shape of 'PTBoxProxydata::Proxyzoo').

Value

object of 'PTBoxProxydata::Proxyzoo' (see *Details* for return formatting, Proxyzoo for shape of 'PTBoxProxydata::Proxyzoo')

paleovar/ptboxproxydata documentation built on June 1, 2022, 1:12 a.m.