Skip to content

Commit

Permalink
changed order of parameters for get_raster and added doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rociojoo committed Jan 23, 2025
1 parent 7f8e477 commit c2b63c0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
12 changes: 7 additions & 5 deletions R/get_raster.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
#' 'DAILY', 'MONTHLY', 'YEARLY'
#' @param group_by parameter to group by. Can be 'VESSEL_ID', 'FLAG', 'GEARTYPE',
#' 'FLAGANDGEARTYPE' or 'MMSI'. Optional.
#' @param filter_by parameter to filter by.
#' @param filter_by Possible fields to filter by are: flag, geartype and vessel_id.
#' filter_by works together with group_by. You can aggregate results using group_by,
#' for example by flag, and then do "flag IN ('ESP')".
#' @param start_date Required. Start of date range to search events, in YYYY-MM-DD format and including this date
#' @param end_date Required. End of date range to search events, in YYYY-MM-DD format and excluding this date
#' @param region sf shape to filter raster or GFW region code (such as a
Expand Down Expand Up @@ -54,14 +56,14 @@
#' key = gfw_auth(),
#' print_request = TRUE)
#' }
get_raster <- function(spatial_resolution = NULL,
get_raster <- function(start_date = "2023-01-01",
end_date = "2023-12-31",
spatial_resolution = NULL,
temporal_resolution = NULL,
group_by = NULL,
filter_by = NULL,
start_date = "2023-01-01",
end_date = "2023-12-31",
region = NULL,
region_source = NULL,
region = NULL,
key = gfw_auth(),
print_request = FALSE) {
date_range <- paste(start_date, end_date, sep = ",")
Expand Down
20 changes: 11 additions & 9 deletions man/get_raster.Rd

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

0 comments on commit c2b63c0

Please sign in to comment.