dad (version 4.1.6)

print.foldermtg: Printing an object of class foldermtg

Description

print function, applied to an object of class "foldermtg", prints an MTG (Multiscale Tree Graph) folder, as returned by foldermtg function.

Usage

# S3 method for foldermtg
print(x, classes = TRUE, description = FALSE, features = TRUE,
  topology = FALSE, coordinates = FALSE, ...)

Arguments

x

an object of class foldermtg.

classes

logical. If TRUE (default), prints the data frame describing the classes (CLASSES: table in the MTG file).

description

logical. If TRUE (default: FALSE), prints the description data frame (DESCRIPTION: table in the MTG file).

features

logical. If TRUE (default), prints the data frame of the features and their types (FEATURES: table in the MTG file).

topology

logical. If TRUE (default: FALSE), prints the data frame of the plant topology.

coordinates

logical. If TRUE (default: FALSE), prints the spatial coordinates of the entities of the plant.

...

optional arguments to print methods.

Author

Rachid Boumaza, Pierre Santagostini, Smail Yousfi, Gilles Hunault, Sabine Demotes-Mainard

Details

If classes, description or features are TRUE, the corresponding data frames are displayed.

If topology = TRUE, the plant structure is displayed; and if coordinates = TRUE, the spatial coordinates are displayed.

By default, the data frames containing the features on the vertices per class are printed.

References

Pradal, C., Godin, C. and Cokelaer, T. (2023). MTG user guide

See Also

read.mtg: reads a MTG file and creates an object of class "foldermtg".

Examples

mtgfile1 <- system.file("extdata/plant1.mtg", package = "dad")
xmtg1 <- read.mtg(mtgfile1)
print(xmtg1)
print(xmtg1, topology = TRUE)
print(xmtg1, coordinates = TRUE)

mtgfile2 <- system.file("extdata/plant2.mtg", package = "dad")
xmtg2 <- read.mtg(mtgfile2)
print(xmtg2)
print(xmtg2, topology = TRUE)
print(xmtg2, coordinates = TRUE)