Combine_Surfaces: Combine multiple resistance surfaces together

View source: R/Combine_Surfaces.R

Combine_SurfacesR Documentation

Combine multiple resistance surfaces together

Description

Combine multiple resistance surfaces into new composite surface based on specified parameters

Usage

Combine_Surfaces(PARM, 
                        CS.inputs = NULL, 
                        gdist.inputs = NULL, 
                        jl.inputs = NULL,
                        GA.inputs, 
                        out = NULL, 
                        File.name, 
                        rescale = TRUE, 
                        p.contribution = FALSE)

Arguments

PARM

Parameters to transform conintuous surface or resistance values of categorical surface. Requires a vector with parameters specified in the order of resistance surfaces

CS.inputs

Object created from running CS.prep function. Defined if optimizing using CIRCUITSCAPE

gdist.inputs

Object created from running gdist.prep function. Defined if optimizing using gdistance

jl.inputs

Object created from running jl.prep function. Defined if optimizing using CIRCUITSCAPE run in Julia

GA.inputs

Object created from running GA.prep function.

out

Directory to write combined .asc file. Default = NULL and no files are exported

File.name

Name of output .asc file. Default is the combination of all surfaces combined, separated by "."

rescale

Locical. If TRUE (default), the values of the combined raster surface will be divided by the minimum value to create a resistance surface with a minimum value = 1.

p.contribution

Logical. If TRUE, the function will return a list object containing (1) the combined raster surface and (2) the average contribution of each surface to the resistance values of the combined surface.

Details

PARM is designed to accept the output of MS_optim. For continuous surfaces, there are three terms: 1) Transformation, 2) shape, and 3) maximum value. Transformation must be provided as a numeric value:

1 = "Inverse-Reverse Monomolecular"
2 = "Inverse-Reverse Ricker"
3 = "Monomolecular"
4 = "Ricker"
5 = "Reverse Monomolecular"
6 = "Reverse Ricker"
7 = "Inverse Monomolecular"
8 = "Inverse Ricker"
9 = "Distance"

The Distance transformation sets all values equal to one. Because of the flexibility of the Ricker function to take a monomolecular shape (try Plot.trans(PARM=c(10,100), Resistance=c(1,10), transformation="Ricker") to see this), whenever a shape parameter >6 is selected in combination with a Ricker family transformation, the transformation reverts to a Distance transformation. In general, it seems that using a combination of intermediate Ricker and Monomolecular transformations provides the best, most flexible coverage of parameter space.

Value

R raster object that is the sum all transformed and/or reclassified resistance surfaces provided

Author(s)

Bill Peterman <Peterman.73@osu.edu>

Examples

 
## Not run:
## *** TO BE COMPLETED *** ##

## End (Not run)

wpeterman/ResistanceGA documentation built on Nov. 20, 2023, 11:50 p.m.