From c2333712be0b3aeda216f6ceb5036334c24bdf7f Mon Sep 17 00:00:00 2001 From: Michael Sumner Date: Sat, 1 Jun 2024 08:33:36 +0000 Subject: [PATCH] fix doc problems --- R/00_read_block.R | 1 + R/00_warpgeneral.R | 3 ++- R/raster-input.R | 1 + R/vapour_vrt.R | 2 ++ man/gdal_raster_data.Rd | 2 +- man/vapour_read_raster_block.Rd | 2 ++ man/vapour_vrt.Rd | 2 ++ man/vapour_warp_raster.Rd | 3 ++- 8 files changed, 13 insertions(+), 3 deletions(-) diff --git a/R/00_read_block.R b/R/00_read_block.R index d15c08ab..53ca029d 100644 --- a/R/00_read_block.R +++ b/R/00_read_block.R @@ -130,6 +130,7 @@ vapour_create_copy <- function(dsource, filename, overwrite = FALSE, driver = "G #' @param band_output_type numeric type of band to apply (else the native type if '') can be one of 'Byte', 'Int32', or 'Float64' #' @param band which band to read (1-based) #' @param unscale default is `TRUE` so native values will be converted by offset and scale to floating point +#' @param nara if 'TRUE' return in nativeRaster format #' #' @return a list with a vector of data from the band read #' @export diff --git a/R/00_warpgeneral.R b/R/00_warpgeneral.R index 7f8b2afb..cc131cda 100644 --- a/R/00_warpgeneral.R +++ b/R/00_warpgeneral.R @@ -15,8 +15,9 @@ #' @param resample resampling algorithm used #' @param bands band or bands to include, default is first band only (use NULL or a value less that one to obtain all bands) #' @param band_output_type specify the band type, see [vapour_read_raster] +#' @param include_meta metadata is attached, turn off by setting this to `FALSE` #' @param options general options passed to gdal warper -#' @param out_dsn use with [gdal_raster_dsn] optionally set the output file name (or one will be generated) +#' #' @export #' @returns pixel values in a list vector per band, or a list of file paths #' diff --git a/R/raster-input.R b/R/raster-input.R index 8b3bedee..e7965b64 100644 --- a/R/raster-input.R +++ b/R/raster-input.R @@ -323,6 +323,7 @@ vapour_read_raster_hex <- function(x, band = 1, #' @param options character vectors of options as per the gdalwarp command line #' @param nomd if `TRUE` the Metadata tag is removed from the resulting VRT (it can be quite substantial) #' @param overview pick an integer overview from the source (0L is highest resolution, default -1L does nothing) +#' nara if 'TRUE' return in nativeRaster format #' @export #' @seealso vapour_read_raster vapour_read_raster_raw vapour_read_raster_int vapour_read_raster_dbl vapour_read_raster_chr vapour_read_raster_hex #' @return list of vectors (only 1 for 'band') of numeric values, in raster order diff --git a/R/vapour_vrt.R b/R/vapour_vrt.R index 1b024824..8a4f274d 100644 --- a/R/vapour_vrt.R +++ b/R/vapour_vrt.R @@ -62,7 +62,9 @@ #' @param geolocation vector of 2 dsn to longitude, latitude geolocation array sources #' @return VRT character string (for use by GDAL-capable tools, i.e. reading raster) #' @param nomd if `TRUE` the Metadata tag is removed from the resulting VRT (it can be quite substantial) +#' @param options pass in options to the VRT creation, like 'c("-expand", "rgb", "-ot", "Byte"(' #' @param overview pick an integer overview from the source (0L is highest resolution, default -1L does nothing) +#' #' @export #' #' @examples diff --git a/man/gdal_raster_data.Rd b/man/gdal_raster_data.Rd index b461ae02..35d20c4b 100644 --- a/man/gdal_raster_data.Rd +++ b/man/gdal_raster_data.Rd @@ -79,7 +79,7 @@ gdal_raster_nara( \item{options}{general options passed to gdal warper} -\item{out_dsn}{use with \link{gdal_raster_dsn} optionally set the output file name (or one will be generated)} +\item{include_meta}{metadata is attached, turn off by setting this to \code{FALSE}} } \value{ pixel values in a list vector per band, or a list of file paths diff --git a/man/vapour_read_raster_block.Rd b/man/vapour_read_raster_block.Rd index 32cbe50c..e907598c 100644 --- a/man/vapour_read_raster_block.Rd +++ b/man/vapour_read_raster_block.Rd @@ -26,6 +26,8 @@ vapour_read_raster_block( \item{band_output_type}{numeric type of band to apply (else the native type if '') can be one of 'Byte', 'Int32', or 'Float64'} \item{unscale}{default is \code{TRUE} so native values will be converted by offset and scale to floating point} + +\item{nara}{if 'TRUE' return in nativeRaster format} } \value{ a list with a vector of data from the band read diff --git a/man/vapour_vrt.Rd b/man/vapour_vrt.Rd index 6ff31445..b1232654 100644 --- a/man/vapour_vrt.Rd +++ b/man/vapour_vrt.Rd @@ -38,6 +38,8 @@ vapour_vrt( \item{nomd}{if \code{TRUE} the Metadata tag is removed from the resulting VRT (it can be quite substantial)} \item{overview}{pick an integer overview from the source (0L is highest resolution, default -1L does nothing)} + +\item{options}{pass in options to the VRT creation, like 'c("-expand", "rgb", "-ot", "Byte"('} } \value{ VRT character string (for use by GDAL-capable tools, i.e. reading raster) diff --git a/man/vapour_warp_raster.Rd b/man/vapour_warp_raster.Rd index 477a2f3f..3ca4d290 100644 --- a/man/vapour_warp_raster.Rd +++ b/man/vapour_warp_raster.Rd @@ -61,7 +61,8 @@ vapour_warp_raster( \item{nomd}{if \code{TRUE} the Metadata tag is removed from the resulting VRT (it can be quite substantial)} -\item{overview}{pick an integer overview from the source (0L is highest resolution, default -1L does nothing)} +\item{overview}{pick an integer overview from the source (0L is highest resolution, default -1L does nothing) +nara if 'TRUE' return in nativeRaster format} } \value{ list of vectors (only 1 for 'band') of numeric values, in raster order