CTFS.utilities {CTFS} | R Documentation

## Overview of Functions that are CTFS Utilities

### Description

Provides an overview of a variety of functions that perform tasks associated with other CTFS functions. Only those that are appropriate to use alone are listed here. Utilities that are only called by other functions are found in `CTFS-internal`.

### Details

CTFS UTILITIES

1. Functions for Miscellaneous Computations

`find.climits`
  Computes 95% CI for a Single Annual Mortality Rate.
`fill.dimension`
  Fills all the dimensions of a 2 dimensional array.
`fill.1dimension`
  Fills all the dimensions of a 1 dimensional array.
`rndown5`
  Rounds down DBH where measurement was less precise than 1 mm.
`trim.growth`
  Removes extreme values of growth using user defined limits.
`unwind.matrix`
  Turns a matrix into a vector, “unwinding” it by columns.
`xydist`
  Distance between x,y coordinates.
`xydistvect`
  Distance between vector of x,y coordinates, x as first element, y as second. Used with `apply`.

2. Functions for Converting Dates

`tojulian`
  Converts Calendar Dates to Julian Dates and Back.
`fromjulian`
  Converts Calendar Dates to Julian Dates and Back.

3. Dunctions for Creating Grouping Variables for Trees see `link{CTFS.groupcats}`

`sep.quadinfo`
  Creates a Vector of Quadrate Characteristics for each Tree in a Dataset.
`sep.sppinfo`
  Creates a Vector of Species Characteristics for each Tree in a Dataset.
`sep.dbh`
  Creates a Vector of DBH Classes for each Tree in a Dataset.

4. Functions for Manipulating Quadrates and X, Y Coordinates see `CTFS.quadfunctions`

`rowcol.to.index`
  Converts a Row and Column to a Quadrate Number
`index.to.rowcol`
  Converts a Quadrate Number (Indext) to Row and Column Numbers
`gxgy.to.index`
  Converts GX GY Coordinates to a Quadrate Number
`index.to.gxgy`
  Converts a Quadrate Number to GX GY Coordinates
`gxgy.to.rowcol`
  Converts a GX GY Coordinates to Row and Column Numbers
`gxgy.to.hectindex`
  Converts GX GY Coordinates to a Hectare Number

5. Functions for Reading, Writing and Converting CTFS Data Files see `CTFS.readwrite`

`sep.data`
  Re-structures a dataframe into a list of dataframes by values of a Column in the dataframe using a variable in the initial dataframe. Replacement for: `splitdata`.
`sep.vct.data`
  Re-structures a dataframe into a list of dataframes by values of a Column in the dataframe using a vector of a variable not in the initial dataframe. Replacement for: `splitdata`.
`mergecensus`
  Merges two Censuses into one dataframe and sets the value of `status`.
`create.status`
  Sets the value of `status` for a single census dataset.
`texttordata`
  Creates CTFS R dataframe from any tab delimited text file.
`sep.species`
  Separate One or More Dataframes of Tree Records from a List. If a single species name is provided, a data frame of the tree records of that species is returned. This is the same as `load.species`. If a vector of species names is provided, then a list of the dataframes of those species is returned.
`load.species`
  Separate One or More Dataframes of Tree Records from a List. A more limited function than `sep.species`. The same effect can be achieved with `siteyear.spp$sppname` where `siteyear.spp` is a list created using `sep.data`, eg. `tst.bci90.spp` and `sppname` is one of the list names.
`readelevdata`
  Read a Text or RData dataframe and Make a matrix, Specifically for Elevation Data.

6. Functions for Organizing Results from other Runctions see `CTFS.readwrite`

`assemble.demography`
  Reformat the Output from Demographic Functions from list to dataframe.
`assemble.table.each`
  Reformat the Output from Demographic Functions from list to dataframe.

### Note

For developers: The date conversion, quad and functions are found in “utilities.R”. The read and write and creating groups functions are found in “readandwrite.R”.

### Author(s)

Rick Condit, Suzanne Lao and Pamela Hall

### See Also

`CTFS.quadfunctions`, `CTFS.readwrite`, `CTFS.groupcats`

[Package CTFS version 1.00 Index]