Generate Text Report of Basin Refinement Process

Creates a paragraph suitable for inclusion in a methods section describing the basin refinement process with specific parameter values and counts.

Usage

generate.refinement.report(basins.result, response.name = "\\widehat{sPTB}")

Arguments

basins.result

Object returned by compute.gfc()

response.name

Character string naming the response variable in LaTeX format, for example "\widehat{sPTB}".

Value

Character string containing the formatted paragraph ready for inclusion in a LaTeX document.

See also

compute.gfc for computing refined basins

Examples

if (FALSE) { # \dontrun{
result <- compute.gfc(adj.list, edge.length.list, fitted.values,
                                 edge.length.quantile.thld = 0.9,
                                 min.basin.size = 10,
                                 expand.basins = TRUE,
                                 verbose = TRUE)

report <- generate.refinement.report(result)
cat(report)

## Write to file for inclusion in Rmd/LaTeX document
writeLines(report, "refinement_methods.tex")
} # }