CompadreDB-Methods: Methods for CompadreDB objects

In Rcompadre: Utilities for using the 'COM(P)ADRE' Matrix Model Database

Methods for CompadreDB objects

Description

This page describes a variety of methods that can be used with CompadreDB objects, including common data frame operations (head, names, and merge), conversion methods (as.data.frame and as_tibble), and methods to calculate the number of species (NumberAcceptedSpecies), studies (NumberStudies), or matrices (NumberMatrices).

Usage

## S3 method for class 'CompadreDB'
as.data.frame(x, ...)

## S3 method for class 'CompadreDB'
as_tibble(
  x,
  .rows = NULL,
  .name_repair = c("check_unique", "unique", "universal", "minimal"),
  rownames = NULL,
  ...
)

## S3 method for class 'CompadreDB'
head(x, n = 6L, ...)

## S3 method for class 'CompadreDB'
tail(x, n = 6L, ...)

## S3 method for class 'CompadreDB'
names(x)

## S3 method for class 'CompadreDB'
dim(x)

## S3 method for class 'CompadreDB'
merge(x, y, ...)

NumberAcceptedSpecies(object)

## S4 method for signature 'CompadreDB'
NumberAcceptedSpecies(object)

NumberStudies(object)

## S4 method for signature 'CompadreDB'
NumberStudies(object)

NumberMatrices(object)

## S4 method for signature 'CompadreDB'
NumberMatrices(object)

Arguments

x, object	A CompadreDB object
...	additional arguments
.rows	passed to [tibble::as_tibble()]
.name_repair	passed to [tibble::as_tibble()]
rownames	passed to [tibble::as_tibble()]
n	The number of rows to extract
y	A data.frame to merge with x

Value

No return value, called for side effects

Rcompadre documentation built on Oct. 17, 2024, 1:07 a.m.