Merge pull request #169 from brownag/doc-updates

Doc updates

Author: njtierney

R/geotargets-option.R

@@ -5,13 +5,13 @@
 #'
 #' @param gdal_raster_driver character, length 1; set the driver used for raster
 #'   data in target store (default: `"GTiff"`). Options for driver names can be
-#'   found here: <https://gdal.org/drivers/raster/index.html>.
+#'   found here: <https://gdal.org/en/stable/drivers/raster/index.html>.
 #' @param gdal_raster_creation_options character; set the GDAL creation options
 #'   used when writing raster files to target store (default: `""`). You may
 #'   specify multiple values e.g. `c("COMPRESS=DEFLATE", "TFW=YES")`. Each GDAL
 #'   driver supports a unique set of creation options. For example, with the
 #'   default `"GTiff"` driver:
-#'   <https://gdal.org/drivers/raster/gtiff.html#creation-options>.
+#'   <https://gdal.org/en/stable/drivers/raster/gtiff.html#creation-options>.
 #' @param gdal_raster_data_type character; Data type for writing raster file.
 #'   One of: `"INT1U"`, `"INT2U"`, `"INT4U"`, `"INT8U"`, `"INT2S"`, `"INT4S"`,
 #'   `"INT8S"`, `"FLT4S"`, `"FLT8S"` (for terra), or `"Byte"`, `"UInt16"`,
@@ -25,7 +25,7 @@
 #'   `c("WRITE_BBOX=YES", "COORDINATE_PRECISION=10")`. Each GDAL driver supports
 #'   a unique set of creation options. For example, with the default `"GPKG"`
 #'   driver:
-#'   <https://gdal.org/drivers/vector/gpkg.html#layer-creation-options>
+#'   <https://gdal.org/en/stable/drivers/vector/gpkg.html#layer-creation-options>
 #' @param terra_preserve_metadata character. When `"drop"` (default), any
 #'   auxiliary files that would be written by [terra::writeRaster()] containing
 #'   raster metadata such as units and datetimes are lost (note that this does

R/tar-stars.R

@@ -25,7 +25,7 @@
 #'  will be read as an object of class `stars_proxy`. Otherwise, the object is
 #'  class `stars`.
 #' @param mdim logical. Use the [Multidimensional Raster Data
-#'  Model](https://gdal.org/user/multidim_raster_data_model.html) via
+#'  Model](https://gdal.org/en/stable/user/multidim_raster_data_model.html) via
 #'  [stars::write_mdim()]? Default: `FALSE`. Only supported for some drivers,
 #'  e.g. `"netCDF"` or `"Zarr"`.
 #' @param ncdf logical. Use the NetCDF library directly to read data via

R/tar-terra-vrt.R

@@ -19,6 +19,7 @@
 #' @importFrom rlang %||% arg_match0
 #' @seealso [tar_terra_tiles()]
 #' @export
+#' @return target class "tar_stem" for use in a target pipeline
 #' @examples
 #' if (Sys.getenv("TAR_LONG_EXAMPLES") == "true") {
 #'  targets::tar_dir({ # tar_dir() runs code from a temporary directory.