Spell-check documentation. Use package spelling.

DESCRIPTION

@@ -2,14 +2,14 @@ Package: sit
 Type: Package
 Title: Analyse Mark-Release-Recapture Data from Sterile Insect
         Technique (SIT) Field Experiments
-Version: 1.1.2.9003
+Version: 1.1.2.9004
 Authors@R: c(person("Françoise", "Chirara", email =
         "francoise.chirara@cirad.fr", role = c("ctb"), comment = "Logo
         designer"), person("Facundo", "Muñoz", email =
         "facundo.munoz@cirad.fr", role = c("aut", "cre"), comment =
         c("Package developer", ORCID = "0000-0002-5061-4241")),
-        person("Joint FAO/IAEA Centre of Nuclear Techniques in Food and Agriculture",
-        role = c("fnd", "cph")))
+        person("Joint FAO/IAEA Centre of Nuclear Techniques in Food and
+        Agriculture", role = c("fnd", "cph")))
 Description: Import field data about the study design such as the
         location and types of adult and egg traps, the release events,
         the trap surveys and the egg hatches. Provide functions to
@@ -20,8 +20,8 @@ License: GPL-3
 Encoding: UTF-8
 Depends: R (>= 4.0)
 Imports: cli, dm, glue, rlang, sf, units, tidyr, knitr
-Suggests: tmap, covr, DiagrammeR, DiagrammeRsvg, dplyr, rmarkdown,
-        testthat (>= 3.0.0), tibble, kableExtra, ggplot2
+Suggests: spelling, tmap, covr, DiagrammeR, DiagrammeRsvg, dplyr,
+        rmarkdown, testthat (>= 3.0.0), tibble, kableExtra, ggplot2
 LazyData: true
 URL: https://umr-astre.pages.mia.inra.fr/sit,
         https://forgemia.inra.fr/umr-astre/sit
@@ -30,3 +30,4 @@ VignetteBuilder: knitr
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.2
 Config/testthat/edition: 3
+Language: en-GB

R/dispersal.R

@@ -228,7 +228,7 @@ survey_distances_from_release <- function(x) {
 #' Compute a vector of weights for a set of elements (traps), to account for
 #' inhomogeneous spatial distribution relative to a reference (release) point.
 #'
-#' The _radial density_ of traps (i.e. number of traps in a ring (r, r+dr),
+#' The _radial density_ of traps (i.e. number of traps in a ring ($r$, $r+dr$),
 #' divided by the surface area of the ring) is proportional to the radius under
 #' a spatially homogeneous distribution of traps, with a proportionality
 #' constant of \eqn{2 / R^2},  where \eqn{R} is the maximum radius.

R/sit_revents.R

@@ -238,7 +238,7 @@ c.sit_revents <- function(...) {
 
 #' @describeIn sit_revents Extracts release events.
 #' @param type Character vector. Which _types_ of release events to retrieve.
-#'   Either `point` or `areal` or both (defatul).
+#'   Either `point` or `areal` or both (default).
 #' @export
 sit_revents.sit <- function(x, type = c('point', 'areal'), ...) {
 

README.Rmd

@@ -113,7 +113,7 @@ We use some fake data for demonstration purposes. See `?fake_sit`.
     This toy example requires disabling the `spatial_adjustment` because there are
     too few traps in this unrealistic situation.
     But this is not the case in general.
-    See [Retreiving Results](retrieving.html) for details on the spatial adjustment.
+    See [Retrieving Results](retrieving.html) for details on the spatial adjustment.
     
     ```{r queries-competitiveness}
     sit_competitiveness(my_sit)

README.md

@@ -154,22 +154,22 @@ We use some fake data for demonstration purposes. See `?fake_sit`.
 
     This toy example requires disabling the `spatial_adjustment` because
     there are too few traps in this unrealistic situation. But this is
-    not the case in general. See [Retreiving Results](retrieving.html)
+    not the case in general. See [Retrieving Results](retrieving.html)
     for details on the spatial adjustment.
 
     ``` r
     sit_competitiveness(my_sit)
     #> 
     #> ── Sterile male competitiveness ────────────────────────────────────────────────
-    #> ℹ Estimated value: 2.14
+    #> ℹ Estimated value: 1.92
     #> 
     #> 
     #> Component                         Value
     #> -------------------------------  ------
-    #> Sterile-wild mortaility ratio      0.80
+    #> Sterile-wild male ratio            0.80
     #> Natural fertility                  1.00
     #> Observed fertility in SIT area     0.40
-    #> Sterile fertility (assumed)        0.05
+    #> Sterile fertility (assumed)        0.01
     ```
 
     ``` r

inst/WORDLIST

+BG
+BGS
+CRS
+Ch
+DD
+Dt
+EPSG
+Edzer
+Eq
+FAO
+Fick's
+GDAL
+GEOS
+Geocomputation
+GitLab
+Grolemund
+Irizarry
+MDD
+MRR
+MSD
+ORCID
+OpenStreetMap
+Ovitraps
+PDS
+POSIXct
+Pebesma
+PostgreSQL
+Proj
+RStudio
+SQLite
+VSCode
+YYYY
+bigg
+cdot
+datetime
+dm
+dr
+ed
+etc
+frac
+ijk
+ik
+jk
+kable
+ovitrap
+ovitraps
+rd
+rs
+spatialised
+sw

man/inverse_radial_density.Rd

@@ -19,7 +19,7 @@ Compute a vector of weights for a set of elements (traps), to account for
 inhomogeneous spatial distribution relative to a reference (release) point.
 }
 \details{
-The \emph{radial density} of traps (i.e. number of traps in a ring (r, r+dr),
+The \emph{radial density} of traps (i.e. number of traps in a ring ($r$, $r+dr$),
 divided by the surface area of the ring) is proportional to the radius under
 a spatially homogeneous distribution of traps, with a proportionality
 constant of \eqn{2 / R^2},  where \eqn{R} is the maximum radius.

man/sit_revents.Rd

@@ -37,7 +37,7 @@ the \href{https://en.wikipedia.org/wiki/ISO_8601}{ISO 8601 format}), i.e.,
 \item{species}{Optional character. Released species.}
 
 \item{type}{Character vector. Which \emph{types} of release events to retrieve.
-Either \code{point} or \code{areal} or both (defatul).}
+Either \code{point} or \code{areal} or both (default).}
 }
 \value{
 A object of class \code{sit_revents} which can be used in \code{\link[=sit]{sit()}}.

tests/spelling.R

+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)