forked from derek-corcoran-barrios/NetworkExtinction
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRandomExtinctions.Rd
106 lines (84 loc) · 5.08 KB
/
RandomExtinctions.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Extintions.R
\name{RandomExtinctions}
\alias{RandomExtinctions}
\title{Random extinction}
\usage{
RandomExtinctions(
Network,
nsim = 10,
Record = FALSE,
plot = FALSE,
SimNum = NULL,
NetworkType = "Trophic",
clust.method = "cluster_infomap",
parallel = FALSE,
ncores,
IS = 0,
Rewiring = FALSE,
RewiringDist = NULL,
RewiringProb = 0.5,
verbose = TRUE,
forceFULL = FALSE
)
}
\arguments{
\item{Network}{a network representation as a an adjacency matrix, edgelist,
or a network object}
\item{nsim}{numeric, number of simulations}
\item{Record}{logical, if TRUE, records every simulation and you can read the
raw results in the object FullSims}
\item{plot}{logical if TRUE, will add a graph to the results}
\item{SimNum}{numeric, how many nodes to register for primary extinction. By default sets all of them.}
\item{NetworkType}{a character with the options Trophic and Mutualistic - is used to calculate secondary extinctions.}
\item{clust.method}{a character with the options cluster_edge_betweenness,
cluster_label_prop or cluster_infomap, defaults to cluster_infomap}
\item{parallel}{if TRUE, it will use parallel procesing, if FALSE (default) it will run
sequentially}
\item{ncores}{numeric, number of cores to use if using parallel procesing}
\item{IS}{either numeric or a named vector of numerics. Identifies the threshold of relative interaction strength which species require to not be considered secondarily extinct (i.e. IS = 0.3 leads to removal of all nodes which lose 70 precent of their interaction strength in the Network argument). If a named vector, names must correspond to vertex names in Network argument.}
\item{Rewiring}{either a function or a named vector of functions. Signifies how rewiring probabilities are calculated from the RewiringDist argument. If FALSE, no rewiring is carried out.}
\item{RewiringDist}{a numeric matrix of NxN dimension (N... number of nodes in Network). Contains, for example, phylogenetic or functional trait distances between nodes in Network which are used by the Rewiring argument to calculate rewiring probabilities. If Rewiring == function(x){x}, this matrix is expected to contain probabilities of a connection being present between species-pairs.}
\item{RewiringProb}{a numeric which identifies the threshold at which to assume rewiring potential is met.}
\item{verbose}{Logical. Whether to report on function progress or not.}
\item{forceFULL}{Logical. Whether to continue removal of nodes after initial order has been depleted. This will force the simulations to execute extinctions and check for secondary extinctions/new links until the network does not change anylonger.}
}
\value{
exports list containing a data frame with the characteristics of the network after every extinction, a network object containing the final network, and a graph with the mean and 95percent interval. The resulting data frame contains 11 columns that incorporate the topological index, the secondary extinctions, predation release, and total extinctions of the network in each primary extinction.
}
\description{
Generates a null model by generating random extinction histories and calculating the mean and standard deviation of the accumulated secondary extinctions developed by making n random extinction histories.
}
\details{
"Note: When using the pre-defined order of nodes for primary
removals option in the random extinction scenario, it is possible
that some of the species in the predefined order may be lost as
secondary extinctions. As such, they should not be counted as
primary removals. For example, if a network has five species {A,B,
,D,E} and a pre-defined "random" order of removal {C,A,B,E,D} with
removal of C causing the additional loss of A and removal of B
causing the additional loss of E and D, only two primary removals
(C and B) would be required for total network collapse, even though
the algorithm would terminate at the third element of the removal
vector, i.e., {C,A,B}."
When NetworkType = Trophic, secondary extinctions only occur for any predator, but not producers. If NetworkType = Mutualistic, secondary extinctions occur for all species in the network.
When clust.method = cluster_edge_betweenness computes the network modularity using cluster_edge_betweenness methods from igraph to detect communities
When clust.method = cluster_label_prop computes the network modularity using cluster_label_prop methods from igraph to detect communities
When clust.method = cluster_infomap computes the network modularity using cluster_infomap methods from igraph to detect communities, here the number of nb.trials are equal to the network size
}
\examples{
#first example
\dontrun{
data("More_Connected")
RandomExtinctions(Network = More_Connected, nsim = 20)
# Using parallel procesing
## Detect your number of cores divide by 2
cores <- ceiling(parallel::detectCores()/2)
RandomExtinctions(Network = More_Connected, nsim = 20, parallel = TRUE, ncores = cores)
}
}
\author{
Derek Corcoran <[email protected]>
M. Isidora Ávila-Thieme <[email protected]>
Erik Kusch <[email protected]>
}