Skip to content

Commit

Permalink
remove unnecessary braces from documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
katarzynam-165 committed Jan 20, 2024
1 parent 0f9d9c1 commit 97b068b
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 44 deletions.
22 changes: 11 additions & 11 deletions R/get_observations.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' \item "from_data" - cells for which abundance will be sampled are provided
#' by the user in a `data.frame` with three columns: "x", "y" and "time_step"
#' \item "monitoring_based" - cells from which abundance will be sampled
#' are provided by the user in a matrix object with two columns: “x” and “y”;
#' are provided by the user in a matrix object with two columns: "x" and "y";
#' abundance from given cell is then sampled by different virtual observers
#' in different time steps; whether a survey will be made by
#' the same observer for several years and whether it will not be made at all
Expand All @@ -37,36 +37,36 @@
#' ("[`rbinom`][stats::rbinom()]") is used
#' @param ... other necessary internal parameters:
#' \itemize{
#' \item{`prop`
#' \item `prop`
#'
#' numeric vector of length 1; proportion of cells to be sampled
#' (default `prop = 0.1`);
#' used when `type = "random_one_layer" or "random_all_layers"`,}
#' used when `type = "random_one_layer" or "random_all_layers"`,
#'
#' \item{`points`
#' \item `points`
#'
#' `data.frame` or `matrix` with 3 named numeric columns ("x", "y"
#' and "time_step") containing coordinates and time steps from which
#' observations should be obtained; used when `type = "from_data"`,}
#' observations should be obtained; used when `type = "from_data"`,
#'
#' \item{`cells_coords`
#' \item `cells_coords`
#'
#' `data.frame` or `matrix` with 2 named columns: "x" and "y"; survey plots
#' coordinates; used when `type = "monitoring_based"`}
#' coordinates; used when `type = "monitoring_based"`
#'
#' \item{`prob`
#' \item `prob`
#'
#' numeric vector of length 1; a parameter defining the shape of -
#' [`rgeom`][stats::rgeom()] distribution - it defines whether an observation
#' will be made by the same observer for several years and whether it
#' will not be made at all (default `prob = 0.3`);
#' used when `type = "monitoring_based"`}
#' used when `type = "monitoring_based"`
#'
#' \item{`progress_bar`
#' \item `progress_bar`
#'
#' logical vector of length 1; determines if progress bar for observational
#' process should be displayed (default `progress_bar = FALSE`);
#' used when `type = "monitoring_based"`}
#' used when `type = "monitoring_based"`
#' }
#'
#' @return `data.frame` object with geographic coordinates, time steps,
Expand Down
8 changes: 4 additions & 4 deletions R/initialise.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@
#' @param dens_dep character vector of length 1 specifying if the probability
#' of settling in a target square is (case-sensitive, default `"K2N"`):
#' \itemize{
#' \item{"none" - fully random,}
#' \item{"K" - proportional to the carrying capacity of a target square,}
#' \item{"K2N" - density-dependent, i.e. proportional to the ratio of
#' \item "none" - fully random,
#' \item "K" - proportional to the carrying capacity of a target square,
#' \item "K2N" - density-dependent, i.e. proportional to the ratio of
#' carrying capacity of a target square to the number of individuals
#' already present in a target square}
#' already present in a target square
#' }
#' @param border character vector of length 1 defining how to deal
#' with borders (case-sensitive, default `"absorbing"`):
Expand Down
10 changes: 5 additions & 5 deletions R/sim.R
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@
#' @return This function returns an object of class `sim_results` which is
#' a list containing the following components:
#' \itemize{
#' \item{`extinction` - `TRUE` if population is extinct or `FALSE` otherwise}
#' \item{`simulated_time` - number of simulated time steps without
#' the burn-in ones}
#' \item{`N_map` - 3-dimensional array representing spatio-temporal
#' \item `extinction` - `TRUE` if population is extinct or `FALSE` otherwise
#' \item `simulated_time` - number of simulated time steps without
#' the burn-in ones
#' \item `N_map` - 3-dimensional array representing spatio-temporal
#' variability in population numbers. The first two dimensions correspond to
#' the spatial aspect of the output and the third dimension represents time.}
#' the spatial aspect of the output and the third dimension represents time.
#' }
#'
#' In case of a total extinction, a simulation is stopped before reaching
Expand Down
8 changes: 4 additions & 4 deletions man/disp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions man/get_observations.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/initialise.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/sim.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 97b068b

Please sign in to comment.