popsCompute: IFC_pops Computation

View source: R/popsCompute.R

popsComputeR Documentation

IFC_pops Computation

Description

Function used to compute 'IFC_pops' object
It requires pops, regions and features.

Usage

popsCompute(
  pops,
  regions,
  features,
  pnt_in_poly_algorithm = 1,
  pnt_in_poly_epsilon = 1e-12,
  display_progress = TRUE,
  title_progress = "",
  ...
)

Arguments

pops

list of populations that will be coerced by buildPopulation.

regions

an object of class 'IFC_regions', list of regions.

features

an object of class 'IFC_features', data.frame of features.

pnt_in_poly_algorithm

algorithm used to determine if object belongs to a polygon region or not. Default is 1.
Note that for the moment only 1(Trigonometry) is available.

pnt_in_poly_epsilon

epsilon to determine if object belongs to a polygon region or not. It only applies when algorithm is 1. Default is 1e-12.

display_progress

whether to display a progress bar. Default is TRUE.

title_progress

character string, giving the title of the progress bar. Default is "".

...

other arguments to be passed.

Value

an object of class 'IFC_pops'.

Source

For pnt_in_poly_algorithm, Trigonometry, is an adaptation of Jeremy VanDerWal's code https://github.com/jjvanderwal/SDMTools


IFC documentation built on Sept. 14, 2023, 1:08 a.m.