default_params_doc: This function does nothing. It is intended to inherit is...
In richelbilderbeek/huisweis: Reproduce Huisman And Weissing 1999

Description Usage Arguments Note Author(s)

This function does nothing. It is intended to inherit is parameters' documentation.

default_params_doc(dt, hsr, hsrs, initial_resource_densities,
  initial_species_densities, max_growth_rate, max_growth_rates, mortality_rates,
  n_species, n_resources, resource_densities, species_densities, srcs,
  supply_rates, t_max, turnover_rate)

`dt`	delta timestep
`hsr`	half-saturation constants for a focal species for each of the resources
`hsrs`	a matrix of half-saturation constants of species (rows) on resources (columns). Can be created by create_hsrs
`initial_resource_densities`	the resource densities at time zero
`initial_species_densities`	the species densities at time zero
`max_growth_rate`	max growth rate of the focal species
`max_growth_rates`	max growth rate of all species
`mortality_rates`	mortality rates of all species
`n_species`	number of species
`n_resources`	number of resources
`resource_densities`	resource densities
`species_densities`	density of all species
`srcs`	a matrix of species' resource content of species (rows) of resources (columns). Can be created by create_srcs
`supply_rates`	the rate at which resources are pumped into the system
`t_max`	simulation will run in steps of `dt` until (not inclusive) this time point is reached
`turnover_rate`	the turnover rate of the whole system

This is an internal function, so it should be marked with @noRd. This is not done, as this will disallow all functions to find the documentation parameters

Richel J.C. Bilderbeek

richelbilderbeek/huisweis documentation built on May 9, 2019, 7:36 a.m.