# Dealing with Multiplatform Satellite Images

## Documentation for package ‘rsat’ version 0.1.18

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A C D E G L M N P R S T U misc

## -- A --

as.data.frame,extent_crs | Coerce to a Data Frame
as.data.frame-method | Coerce to a Data Frame
as.records | Create records object from data frame
as.records,data.frame | Create records object from data frame
as.records-method | Create records object from data frame

## -- C --

c | Combine values into a vector or a list
c-method | Combine values into a vector or a list
character, | Create a new 'records' object
character,sf,character,character | Creates a new 'rtoi' object
character,sf,character,character,records | Creates a new 'rtoi' object
character,sf,character,character,records,size | Creates a new 'rtoi' object
cloud_mask,rtoi | Create cloud mask from an rtoi

## -- D --

Date, | Create a new 'records' object
dates | Get/set the dates from a 'records' or an 'rtoi'
dates-method | Get/set the dates from a 'records' or an 'rtoi'
dates<- | Get/set the dates from a 'records' or an 'rtoi'
dates<--method | Get/set the dates from a 'records' or an 'rtoi'

## -- E --

ex.dem.navarre | A Digital Elevation Model (DEM) of the region of Navarre (Spain)
ex.madrid | A polygon with the border of Madrid (Spain)
ex.manhattan | A polygon with the border of Manhattan (USA)
ex.navarre | A polygon with the border of Navarre (Spain)
ex.ndvi.navarre | A time series of NDVI in Navarre (Spain)
extent_crs | Create a new 'records' object

## -- G --

get_api_name | Get the API name of a 'records'
get_api_name,records | Get the API name of a 'records'
get_api_name-method | Get the API name of a 'records'
get_database | Extracts or assign the path of the database
get_database,rtoi | Extracts or assign the path of the database
get_database-method | Extracts or assign the path of the database
get_dir | Get the file path of a 'records' or an 'rtoi'
get_dir,records | Get the file path of a 'records' or an 'rtoi'
get_dir,rtoi | Get the file path of a 'records' or an 'rtoi'
get_dir-method | Get the file path of a 'records' or an 'rtoi'
get_download | Extract the url to download a data record
get_download-method | Extract the url of the preview
get_order | Get the slot called order from a 'records' or an 'rtoi'
get_order-method | Get the file path of a 'records' or an 'rtoi'
get_order<- | Get the slot called order from a 'records' or an 'rtoi'
get_order<-,records | Get the slot called order from a 'records' or an 'rtoi'
get_order<--method | Get the slot called order from a 'records' or an 'rtoi'
get_preview | Extract the url of the preview
get_preview,records | Extract the url of the preview
get_preview-method | Extract the url of the preview

## -- L --

length-method | Length of an object
logical, | Create a new 'records' object

## -- M --

missing | Create a new 'records' object

## -- N --

names,rtoi | Get the name of the object
names-method | Get the name of the object
names<-,rtoi,character | Get the name of the object
names<--method | Get the name of the object
new_record | Create a new 'records' object
new_record, | Create a new 'records' object
new_record-method | Create a new 'records' object
new_rtoi | Creates a new 'rtoi' object
new_rtoi,character,sf,character,missing,missing | Creates a new 'rtoi' object
new_rtoi-method | Creates a new 'rtoi' object
numeric, | Create a new 'records' object

## -- P --

plot,character | Plot an 'rtoi' object
plot,records | Plot an 'rtoi' object
plot,rtoi,missing | Plot an 'rtoi' object
plot-method | Plot an 'rtoi' object
print,api | Prints the values
print,extent_crs | Prints the values
print,records | Prints the values
print-method | Prints the values
print_credentials | Prints the credentials for the web services
print_credentials-method | Prints the credentials for the web services
product | Get the name of the product from a 'records' or an 'rtoi'
product,records | Get the name of the product from a 'records' or an 'rtoi'
product,rtoi | Get the name of the product from a 'records' or an 'rtoi'
product-method | Get the name of the product from a 'records' or an 'rtoi'

## -- R --

read_rtoi | Reads an rtoi from the hard drive
read_rtoi,character | Reads an rtoi from the hard drive
read_rtoi-method | Reads an rtoi from the hard drive
records | Extracts the satellite records
records,rtoi | Extracts the satellite records
records-class | A class object for satellite image metadata
records-method | Extracts the satellite records
records<- | Extracts the satellite records
records<-,rtoi,records | Extracts the satellite records
records<--method | Extracts the satellite records
region | Extracts region from an rtoi
region,rtoi | Extracts region from an rtoi
region-method | Extracts region from an rtoi
region<- | Extracts region from an rtoi
region<-,rtoi | Extracts region from an rtoi
region<-,rtoi,NULL | Extracts region from an rtoi
region<-,rtoi,sf | Extracts region from an rtoi
region<--method | Extracts region from an rtoi
rename | Renames an 'rtoi'
rename,rtoi,character | Renames an 'rtoi'
rename-method | Renames an 'rtoi'
rsat | 'rsat'
rsat_cloudMask | Create cloud mask from an rtoi
rsat_cloudMask-method | Create cloud mask from an rtoi
rsat_derive | Computes a remote sensing index from an 'rtoi'
rsat_derive,rtoi,character | Computes a remote sensing index from an 'rtoi'
rsat_derive-method | Computes a remote sensing index from an 'rtoi'
rsat_download | Download the images from a 'records' or an 'rtoi' object
rsat_download,records | Download the images from a 'records' or an 'rtoi' object
rsat_download,rtoi | Download the images from a 'records' or an 'rtoi' object
rsat_download-method | Download the images from a 'records' or an 'rtoi' object
rsat_get_raster | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_raster,rtoi | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_raster-method | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_SpatRaster | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_SpatRaster,rtoi | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_SpatRaster-method | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_stars | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_stars,rtoi | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_get_stars-method | Loads into R a time series of images regarding an rtoi, satellite product, and remote sensing index.
rsat_list_data | List the information available for an 'rtoi'
rsat_list_data,rtoi | List the information available for an 'rtoi'
rsat_list_data-method | List the information available for an 'rtoi'
rsat_mosaic | Mosaic the tiles intersecting the region of interest
rsat_mosaic,records | Mosaic the tiles intersecting the region of interest
rsat_mosaic,sf,character | Mosaic the tiles intersecting the region of interest
rsat_mosaic-method | Mosaic the tiles intersecting the region of interest
rsat_preview | Preview a 'records' or an 'rtoi' object
rsat_preview,records,date | Preview a 'records' or an 'rtoi' object
rsat_preview,rtoi,date | Preview a 'records' or an 'rtoi' object
rsat_preview,rtoi,missing | Preview a 'records' or an 'rtoi' object
rsat_preview,rtoi,numeric | Preview a 'records' or an 'rtoi' object
rsat_preview-method | Preview a 'records' or an 'rtoi' object
rsat_search | Search satellite images
rsat_search,rtoi,character | Search satellite images
rsat_search,sf,character | Search satellite images
rsat_search-method | Search satellite images
rsat_smoothing_images | Fill data gaps and smooth outliers in a time series of satellite images
rsat_smoothing_images,rtoi,character | Fill data gaps and smooth outliers in a time series of satellite images
rsat_smoothing_images-method | Fill data gaps and smooth outliers in a time series of satellite images
rtoi-class | Region and Time Of Interest ('rtoi')

## -- S --

sat_name | Get the name of the satellite(s) from a 'records' or an 'rtoi'
sat_name,records | Get the name of the satellite(s) from a 'records' or an 'rtoi'
sat_name,rtoi | Get the name of the satellite(s) from a 'records' or an 'rtoi'
sat_name-method | Get the name of the satellite(s) from a 'records' or an 'rtoi'
set_credentials | Saves the credentials for the web services
set_credentials,character,character,character | Saves the credentials for the web services
set_credentials,character,character,missing | Saves the credentials for the web services
set_credentials-method | Saves the credentials for the web services
set_database | Extracts or assign the path of the database
set_database-method | Extracts or assign the path of the database
show | Show an Object
show,records | Show an Object
show,rtoi | Show an Object
show-method | Show an Object
show_variables | List the variables and satellites supported by 'rsat'
show_variables-method | List the variables and satellites supported by 'rsat'
sub,extent_crs | Extract or replace parts of an object
sub,extent_crs,extent_crs | Extract or replace parts of an object
subset-method | Filter the satellite records of a 'records' or an 'rtoi'

## -- T --

test_function | Testing function

## -- U --

unique | Extract unique elements
unique-method | Extract unique elements

## -- misc --

'[<-',records,records | Extract or replace parts of an object
[-method | Extract or replace parts of an object
[<--method | Extract or replace parts of an object