addServer.Rd 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/addServer.R
  3. \name{addServer}
  4. \alias{addServer}
  5. \title{Add New Remote Server to MODIS Inventory}
  6. \usage{
  7. addServer(name, sensor = "MODIS", basepath, varpath, content = "images",
  8. path_ext = "inst/external", overwrite = FALSE, ...)
  9. }
  10. \arguments{
  11. \item{name}{Character. Name of the remote server that should be added to the
  12. inventory.}
  13. \item{sensor}{Character. Sensor type, defaults to 'MODIS'.}
  14. \item{basepath}{Character. Absolute online server path.}
  15. \item{varpath}{Character. Pattern of organizational structure on server.}
  16. \item{content}{Character. Content type, defaults to "images".}
  17. \item{path_ext}{Character. Path to folder containing file
  18. 'MODIS_FTPinfo.RData'. When working with RStudio projects (.Rproj), this
  19. usually defaults to 'inst/external'.}
  20. \item{overwrite}{Logical. If \code{TRUE}, the initial '.RData' file located
  21. in 'path_ext' will be overwritten.}
  22. \item{...}{Currently not used.}
  23. }
  24. \value{
  25. A 'list' holding the updated contents of 'MODIS_FTPinfo.RData'.
  26. }
  27. \description{
  28. \code{addServer} is a non-exported helper function to add a new entry to the
  29. list of online (FTP) servers featured by \strong{MODIS} (see
  30. \code{MODIS:::MODIS_FTPinfo}).
  31. }
  32. \examples{
  33. \dontrun{
  34. ## E.g., add server of MODIS evapotranspiration product
  35. MODIS:::addServer(name = "NTSG", sensor = "MODIS",
  36. basepath = "ftp://ftp.ntsg.umt.edu/pub/MODIS/NTSG_Products/MOD16/",
  37. varpath = "PRODUCT.CCC/YYYY/DDD/")
  38. }
  39. }
  40. \seealso{
  41. \code{MODIS:::MODIS_FTPinfo}.
  42. }
  43. \author{
  44. Florian Detsch
  45. }