sampling.generate

Generate communities by stratified sampling.

Functions

gen_sample(→ Iterator[tuple[sampling.types.Name, ...)

Generate reps new communities of sizes by stratified sampling of a set

gen_added_value(→ Iterator[tuple[sampling.types.Name, ...)

Generate new sub communities from sources by leave-one-out (sub

Module Contents

sampling.generate.gen_sample(sources: sampling.types.Ecosystem, reps: int = 1, sizes: list[int] | None = None, pool: sampling.types.Community | None = None, name: str | None = None) → Iterator[tuple[sampling.types.Name, sampling.types.Community]][source]

Generate reps new communities of sizes by stratified sampling of a set of sources communities, possibly of size one.

Parameters:

  • sources (sampling.types.Ecosystem) – sequence of named or unnamed source communities

  • reps (int) – number of repetitions of each sample

  • sizes (list[int] | None) – list of sample sizes; if empty, each sample is same size as its source

  • pool (sampling.types.Community | None) – community to round out samples whose sizes are not a multiple of the number of sources; by default, all sources combined

  • name (str | None) – optional prefix for the sample name

Return type:

Iterator[tuple[sampling.types.Name, sampling.types.Community]]

sampling.generate.gen_added_value(sources: sampling.types.Ecosystem, reps: int = 1, pool: sampling.types.Community | None = None, name: str | None = 'added_value') → Iterator[tuple[sampling.types.Name, sampling.types.Community]][source]

Generate new sub communities from sources by leave-one-out (sub minus) or by add-one-in (sub added).

For each original source community of size _N_, generate _N_ minus communities of size _N_-1 by leaving one member out, and reps added communities of size _N_+1 by adding a member from the pool.

Parameters:

  • sources (sampling.types.Ecosystem) – sequence of named or unnamed source communities

  • reps (int) – number of repetitions of each sample

  • pool (sampling.types.Community | None) – community to round out samples whose sizes are not a multiple of the number of sources; by default, all sources combined

  • name (str | None) – optional prefix for sample name

Return type:

Iterator[tuple[sampling.types.Name, sampling.types.Community]]