map_beta_div.Rd 1.52 KB
Newer Older
jbferet's avatar
jbferet committed
1
2
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Lib_MapBetaDiversity.R
3
4
\name{map_beta_div}
\alias{map_beta_div}
jbferet's avatar
jbferet committed
5
6
\title{maps beta diversity indicator based on spectral species distribution}
\usage{
7
map_beta_div(Input.Image.File, Output.Dir, Spatial.Unit,
jbferet's avatar
jbferet committed
8
9
  TypePCA = "SPCA", nbclusters = 50, Nb.Units.Ordin = 2000,
  MinSun = 0.25, pcelim = 0.02, scaling = "PCO", FullRes = TRUE,
10
  LowRes = FALSE, nbCPU = 1, MaxRAM = 0.25)
jbferet's avatar
jbferet committed
11
12
}
\arguments{
13
\item{Input.Image.File}{character. Path and name of the image to be processed.}
jbferet's avatar
jbferet committed
14

15
\item{Output.Dir}{character. Output directory.}
jbferet's avatar
jbferet committed
16

17
\item{Spatial.Unit}{numeric. Dimensions of the spatial unit.}
jbferet's avatar
jbferet committed
18

19
\item{TypePCA}{character. Type of PCA (PCA, SPCA, NLPCA...).}
jbferet's avatar
jbferet committed
20

21
\item{nbclusters}{numeric. Number of clusters defined in k-Means.}
jbferet's avatar
jbferet committed
22

23
\item{Nb.Units.Ordin}{numeric. Maximum number of spatial units to be processed in NMDS.
jbferet's avatar
jbferet committed
24
25
26
--> 1000 will be fast but may not capture important patterns if large area
--> 4000 will be slow but may show better ability to capture landscape patterns}

27
\item{MinSun}{numeric. Minimum proportion of sunlit pixels required to consider plot.}
jbferet's avatar
jbferet committed
28

29
30
31
32
33
34
35
36
37
38
39
\item{pcelim}{numeric. Minimum contribution (in \%) required for a spectral species}

\item{scaling}{character. "PCO" or "NMDS".}

\item{FullRes}{boolean.}

\item{LowRes}{boolean.}

\item{nbCPU}{numeric. Number of CPUs to use in parallel.}

\item{MaxRAM}{numeric. MaxRAM maximum size of chunk in GB to limit RAM allocation when reading image file.}
jbferet's avatar
jbferet committed
40
41
42
43
}
\description{
maps beta diversity indicator based on spectral species distribution
}