Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.67 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.67 KB

SpeciesInteractionSamplers.jl

DOC

SpeciesInteractionSamplers.jl is a Julia package for simulating the process of sampling species interaction networks with spatiotemporal variation in species occurrence. It is built on SpeciesInteractionNetworks.jl, and uses NeutralLandscapes.jl and Distributions.jl to generate species ranges and phenologies that have prescribed statistical properties. This software is associated with the second preprinted version of Catchen et al. 2023.

SpeciesInteractionNetworks.jl makes use of UnicodePlots.jl to make the REPL experience more interactive. If you would like to turn this off, either to remove the slight added latency, or because you hate fun, you can set the variable SpeciesInteractionNetworks.INTERACTIVE_REPL = false.

The documentation can be found here

A Sampled Interaction Network from Scratch in 7 Lines

using SpeciesInteractionSamplers

λ = generate(NicheModel())
relative_abundance = generate(NormalizedLogNormal=0.2), λ)
δ = detectability(RelativeAbundanceScaled(10.0), λ, relative_abundance)

energy = 500
θ = realizable!(NeutrallyForbiddenLinks(energy), λ, relative_abundance)
ζ = realize!(θ)

detected_network = detect!(ζ, δ)

API Design

A thorough description of the SpeciesInteractionSamplers.jl API can be found in the documentation. A diagram conveying the essentials can be seen below.