print.evalBranchAll: print.evalBranchAll

View source: R/printEvalBranch.R

print.evalBranchAllR Documentation

print.evalBranchAll

Description

Prints information from an 'EvalBranch' object or a list containing 'EvalBranch' objects. It summarizes the branch evaluated, initial area, modified area after evaluation, and delta value (percentage change).

Usage

## S3 method for class 'evalBranchAll'
print(object0, compact = TRUE)

Arguments

object0

An 'EvalBranch' object or a list containing 'EvalBranch' objects.

compact

A logical value indicating whether to print the information in a compact format (e.g., branch number instead of full branch string) (default = TRUE).

Value

Prints the formatted information to the console.

Examples

library(blepd)  

# Create an EvalBranch object
evalBranch <- EvalBranch(branchToEval = "Branch1", 

# Print information from the object
print.evalBranchAll(evalBranch)

# Create a list of EvalBranch objects
multiEvalResults <- list(evalBranch, evalBranch)

# Print information from the list
print.evalBranchAll(multiEvalResults, compact = FALSE)

Dmirandae/blepd documentation built on April 2, 2024, 12:24 p.m.