Collection-methods: Create a Collection

In VEuPathDB/veupathUtils: General Helper Functions for VEuPathDB Projects

Create a Collection

Description

This is a constructor for the Collection class. It creates a Collection object for use in a Microbiome Dataset.

Usage

Collection(name, data, recordIdColumn, ancestorIdColumns)

## S4 method for signature 'character,data.frame,character,character'
Collection(name, data, recordIdColumn, ancestorIdColumns)

## S4 method for signature 'character,data.frame,missing,missing'
Collection(name, data, recordIdColumn, ancestorIdColumns)

## S4 method for signature 'character,character,missing,missing'
Collection(name, data, recordIdColumn, ancestorIdColumns)

## S4 method for signature 'character,character,character,character'
Collection(name, data, recordIdColumn, ancestorIdColumns)

## S4 method for signature 'missing,missing,missing,missing'
Collection(name, data, recordIdColumn, ancestorIdColumns)

Arguments

name	The human-readable name of the collection. This can be anything that helps to identify the collection uniquely to the user.
data	A data.frame or a character vector representing a file path to a data.frame
recordIdColumn	The name of the column in the data.frame that contains the record id
ancestorIdColumns	A character vector of column names representing parent entities of the recordIdColumn

VEuPathDB/veupathUtils documentation built on Feb. 8, 2025, 12:29 p.m.