Skip to content

Commit

Permalink
fix doc problems
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsumner committed Jun 1, 2024
1 parent a4b0862 commit c233371
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions R/00_read_block.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion R/00_warpgeneral.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
#'
Expand Down
1 change: 1 addition & 0 deletions R/raster-input.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions R/vapour_vrt.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/gdal_raster_data.Rd

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

2 changes: 2 additions & 0 deletions man/vapour_read_raster_block.Rd

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

2 changes: 2 additions & 0 deletions man/vapour_vrt.Rd

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

3 changes: 2 additions & 1 deletion man/vapour_warp_raster.Rd

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

0 comments on commit c233371

Please sign in to comment.