common_docs: Common arguments and documentation for various functions

In dhope/BASSr: Benefit Applied Strategic Sampling

Common arguments and documentation for various functions

Description

Common arguments and documentation for various functions

Arguments

num_runs	Numeric. Number of times to draw random samples.
n_samples	Numeric. Number of samples to draw in each run.
land_hex	(Spatial) Data frame. Land Cover data by hexagon. If non-spatial, will be converted to spatial sf data frame using the crs and coords arguments. Requires columns identifying the Hex ID as well as the Stratum ID (see hex_id and stratum_id respectively).
stratum_id	Column. Identifies larger area (e.g., StudyAreaID or Province).
hex_id	Column. Identifies hexagon IDs (e.g., default hex_id).
omit_flag	Column identifying hexes to omit (e.g., water hexes).
costs	Data frame. Costs for each hexagon in a RawCost format.
crs	Numeric, character, or sf/sfc. Coordinate reference system. Must be valid input to sf::st_crs().
coords	Character vector. Names of the columns containing X and Y coordinates (default c("lon", "lat")).
non_random_set	Character vector. hex_ids of hexagons to include as a non randomly selected set.
benefit_weight	Numeric. Weight assigned to benefit in the selection probabilities. 0.5 is equal weighting of cost and benefits. 1.0 is zero weighting to cost. Default 0.5.
land_cover_weights	Data frame. Proportional weights (weights column) for specific types of landcover (lc column). lc should correspond to the same landcover column names as the hex data.
return_grts	Logical. Return the spsurvey object(s).
...	Extra named arguments passed on to spsurvey::grts().
seed	Numeric. Random seed to use for random sampling. Seed only applies to specific sampling events (does not change seed in the environment). NULL does not set a seed.
quiet	Logical. Whether to suppress progress messages.

Details

Use ⁠@inheritParams common_docs⁠ to include the above in any function documentation with a matching argument (will only include matching args)

Extra arguments

Extra named arguments for spsurvey::grts() can also be passed on via .... In particular, note that the default values for mindis (minimum distance between sites) is NULL, and maxtry (maximum attempts to try to obtain the minimum distance between sites) is 10.

dhope/BASSr documentation built on April 12, 2024, 9:54 p.m.