goesaodc_listScanFiles: List GOES AOD scan files

Description Usage Arguments Details Value Examples

View source: R/goesaodc_listScanFiles.R

Description

Lists GOES AOD scan files for a given datetime or time range. If just datetime is given, then only the scan file closest to that time will be listed. If endtime is specified as well, then all scans from datetime up to (but not including) endtime will be listed.

Usage

1
2
3
4
5
6
7
8
9
goesaodc_listScanFiles(
  satID = NULL,
  datetime = NULL,
  endtime = NULL,
  timezone = "UTC",
  isJulian = FALSE,
  useRemote = FALSE,
  baseUrl = "https://tools-1.airfire.org/Satellite/"
)

Arguments

satID

ID of the source GOES satellite ('G16' or 'G17').

datetime

Datetime as a Ymd HMS or Julian formatted string, or a POSIXct.

endtime

End time as a Ymd HMS or Julian formatted string, or a POSIXct.

timezone

Timezone used to interpret datetime and endtime. Defaults to UTC.

isJulian

Logical value determining whether datetime (and optionally endtime) should be interpreted as a Julian date with day of year as a decimal number. Defaults to FALSE.

useRemote

Logical specifying whether to look for files in getSatelliteDataDir() or baseUrl. Defaults to FALSE.

baseUrl

URL of remote database. Defaults to "https://tools-1.airfire.org/Satellite/".

Details

If useRemote=FALSE and there are no scan files available for the day of the requested datetime, then NULL will be returned.

Value

Vector of scan filenames.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
library(MazamaSatelliteUtils)
setSatelliteDataDir("~/Data/Satellite")

goesaodc_listScanFiles(
  satID = "G17",
  datetime = "2020-09-08 12:30",
  timezone = "UTC",
  useRemote = TRUE
)

goesaodc_listScanFiles(
  satID = "G17",
  datetime = "2020-09-08 12:00",
  endtime = "2020-09-08 13:00",
  timezone = "UTC",
  useRemote = TRUE
)

MazamaScience/MazamaSatelliteUtils documentation built on Dec. 17, 2021, 3:20 a.m.