Updated documentation of get_cellindex

Author: stephnwirth

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '2814582'
+ValidationKey: '2814724'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'

CITATION.cff

@@ -3,7 +3,7 @@ message: If you use this software, please cite it using the metadata from this f
 type: software
 title: 'lpjmlkit: Toolkit for Basic LPJmL Handling'
 version: 1.4.2
-date-released: '2024-04-08'
+date-released: '2024-04-09'
 abstract: A collection of basic functions to facilitate the work with the Dynamic
   Global Vegetation Model (DGVM) Lund-Potsdam-Jena managed Land (LPJmL) hosted at
   the Potsdam Institute for Climate Impact Research (PIK). It provides functions for

DESCRIPTION

@@ -54,4 +54,4 @@ Suggests:
     sf
 Config/testthat/edition: 3
 VignetteBuilder: knitr
-Date: 2024-04-08
+Date: 2024-04-09

R/get_cellindex.R

@@ -9,8 +9,8 @@
 #' to correct it.
 #'
 #' @param grid_filename A string representing the grid file name.
-#' @param extent A numeric vector of length 4 representing the extent
-#' (lonmin, lonmax, latmin, latmax).
+#' @param extent A numeric vector (lonmin, lonmax, latmin, latmax) containing the
+#'  longitude and latitude boundaries between which values included in the subset.
 #' @param coordinates A list of two named (lon, lat) numeric vectors representing the coordinates.
 #'
 #'
@@ -22,7 +22,7 @@
 #' \dontrun{
 #' get_cellindex(
 #'   grid_filename = "my_grid.bin.json",
-#'   extent = c(-123.25, -122.75, 49.25, 49.75)
+#'   extent = c(-123.25, -122.75, 49.25, 49.75) # (lonmin, lonmax, latmin, latmax)
 #' )
 #' get_cellindex(
 #'   grid_filename = "my_grid.bin.json",