All functions

check_names

A function check feature/group names.

check_path

A function to deal with potentially relative paths.

check_zonation

Check if Zonation is installed.

clean_str

Clean leading and trailing whitespaces from a given string. Additionally, all occurrences of multiple whitespaces are replaced with a single whitespace.

comp

Compare matrices in various ways.

copy_zvariant

Copy existing variant as a new Zvariant object.

correlation

Correlation between two matrices.

cost

Get cost data of a Z* object.

create_spp

Generate spp_file based on a directory of input rasters.

create_zproject

Create a new Zonation project on file system.

cross_jaccard

Calculate Jaccard coefficients bewteen all the RasterLayers within a single RasterStack.

curves

Get curves results data of a Z* object.

decimalplaces

Find out the number of decimal places in a number.

ds_alpha

Calculate alpha value for distribution smoothing.

featurenames featurenames<-

Feature names of Zonation variant.

features_info

Get the features info component of Zresults.

file_path_relative_to

Transform an absolute path to relative path in relation to given location

file_path_sans_ext

Re-implementation of file_path_sans_ext in tools. This version can handle "." just before the file extenstion, unlike the original implementation.

get_dat_param

Get a specified run setting parameter value

get_tutorialdir

Get the directory of Zonation tutorial.

get_variant

Get a specified variant in a Zonation project

groupnames groupnames<-

Get group names for a class Zvariant instance.

groups groups<-

Get group codes of a class Zvariant instance.

has_results

Check which results a Z* object has.

jaccard

Calculate the Jaccard coefficient.

leaf_tags

Find all the leaf tags in a potentially nested list. The generic form of a list is tag = value; find all the tags in a list.

load_zproject

Load a Zonation project.

map_indexes

Map vector to actual column indexes.

names

Names of variants in Zproject

nfeatures

Get the number of feature included in a Zonation variant

nvariants

Get the number of variants included in a Zonation project

opendir

Open the directory of a Zproject using the system file browser.

outdir

Get path to output directory.

parse_bat

Parse the content of a Zonation batch (bat) file and make OS specific adjustments if needed.

performance

Get performance levels.

plot_hist

Create a ggplot2 histogram of a RasterLayer.

plot

Plot Zonation performance curves for individual features.

plot

Plot Zonation performance curves for groups.

ppa_lsm

Get ppa.lsm results data of a Z* object.

print

Print Zvariant information.

rank_raster

Get Zonation result rank raster.

rank_rasters

Get Zonation result rank rasters of a project.

read_bat

Read Zonation-specific (MS Windows) batch file.

read_curves

Read in performance curves produced by Zonation.

read_dat

Read a dat file (Windows-style ini-file) for configuration information.

read_features_info

Read a features info file.

read_groups

Read a groups file.

read_grp_curves

Read in performance curves for grouped features produced by Zonation.

read_ppa_lsm

Read Zonation post-processing analysis (ppa) result file.

read_result_rasters

Read Zonation-specific raster result files.

read_spp

Read Zonation variant specific spp-file.

regroup_curves

Re-calculate group curves data.

require_package

Requires a given package and if not present installs and loads it.

results

Getter method for results (Zresults) in a class Zvariant object.

run_bat

Try to run a given batch (bat) files.

save_zvariant

Saves the current state of an instance of Zvariant-class on the file system. Zvariant object tracks the location of relevant files, but the root path can be changed. If it is not changed, then the current files can be overwritten.

selection_coverage

Intersection of two coverages.

set_dat_param

Set a specified run setting parameter value

set_tutorialdir

Set the package options to point to a correct location of the Zonation tutorial

show

Print Zvariant information.

sppdata sppdata<-

Simple getter mehtod for spp data in a class Zvariantobject.

sppweights sppweights<-

Get biodiversity feature weights of a Zonation variant

variants

Get all variants in a Zonation project

write_dat

Write a Zonation run configuration (dat) file.

The ZCurvesDataFrame class

The ZGroupCurvesDataFrame class

zlegend

Get various Zonation legends

zparameters

Get all Zonation run configuration parameters.

The Zproject class

The Zresults class

The Zvariant class