Compare abundance and diversity in a field survey
Two equally abundant taxa give Simpson dominance 0.5 and an effective count of two.
Run the native CLI
Extract the workflow collection for your platform. Run .\bin\egret.exe --help in PowerShell or ./bin/egret --help on Linux and macOS. Running the command with no arguments prints the worked example.
Build from source
With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.
git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-egret.git cd blyx-egret blyxc native-run project.blyx -- "2,0,2"
Why this framework exists
Two surveys can have the same species count and very different abundance patterns. Report diversity alongside observed richness. scikit-bio, Simpson dominance
Install Egret in your editor
Extension RahulChaube.blyx-egret · 0.1.0
The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.
Create an empty .blyx file, type blyx-egret-demo and accept the completion. Choose Blyx: Run File to run the example.
For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Egret.
Download the companion Blyx Language VSIXLibraries in this framework
Install with Conda
Create an environment containing Egret 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.
conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-egret=0.1.0=0 blyxc native-run ./blyx-env/share/blyx/egret/main.blyx
To use this package in your application, copy share/blyx/egret/vendor/egret from the environment into your project's vendor directory.
Import into a Blyx project
Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.
git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-egret.git vendor/egret
You can also download Egret as a ZIP. Extract its contents into vendor/egret.
Save this as main.blyx beside vendor and run blyxc native-run main.blyx.
use vendor::egret::egret;
fn main() {
let counts = [2, 0, 2];
let result = egret_survey(counts);
if len(result) == 0 { println!("invalid"); return; }
let mut i = 0;
while i < len(result) {
println!(at(result, i));
i += 1;
}
}Expected output
4 2 0 0.5 2
API and input requirements
Returns [individuals, observed taxa, singletons, dominance, effective taxa]. An entirely empty survey has no diversity estimate. Invalid arguments and nonfinite results return an empty vector.
| API | Use |
|---|---|
egret_survey(counts) | Returns [individuals, observed taxa, singletons, dominance, effective taxa]. An entirely empty survey has no diversity estimate. |
Develop and contribute
Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.
