summarise_gcae_input_data: Summarise the 'gcae_input_data'

In richelbilderbeek/gcaer: Interface to GCAE

Summarise the gcae_input_data

Description

Summarise the gcae_input_data

Usage

summarise_gcae_input_data(gcae_input_data, verbose = FALSE)

Arguments

gcae_input_data	in-memory data that can be used as input for GCAE. Use linkread_gcae_input_files to read it from files, use check_gcae_input_data to check it for validity.
verbose	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Value

This function will show the summary using message. A list with all the elements shown is returned as well

Note

this function is named after the base R summarise function

Author(s)

Richèl J.C. Bilderbeek

Examples

gcae_input_data <- create_test_gcae_input_data()
summarise_gcae_input_data(gcae_input_data)

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.