EndCoordinates.Rd 1.9 KB

12345678910111213141516171819202122232425
  1. \name{EndCoordinates}
  2. \alias{EndCoordinates}
  3. \title{Calculate end location of a transect}
  4. \description{Function that uses a set of locations in decimal degrees to calculate new locations, at a specified distance and angle away, that can form the start and end coordinates for transects.}
  5. \usage{EndCoordinates(LoadDat, FileSep = NULL, Distance = 1000, Angle = 90,
  6. AngleUnits = 'radians'|'degrees', Dir = ".", FileName = "Transect Coordinates")}
  7. \arguments{
  8. \item{LoadDat}{Input data; the name of an object or a character string that specifies a file path for an external file to be read in, containing a set of locations to be used for calculating new end coordinates.}
  9. \item{FileSep}{If a file path is entered to LoadDat, specify the file delimiter character.}
  10. \item{Distance}{Numeric; distance, in metres, that the end coordinates should be from the focal coordinates.}
  11. \item{Angle}{Numeric; angle, in either degrees or radians, that the end coordinates should be from the focal coordinates.}
  12. \item{AngleUnits}{Character String; the unit the angle is given in, either 'radians' or 'degrees'.}
  13. \item{Dir}{Character string; an optional argument to specify the subdirectory where the output file should be saved. Default Dir='.' writes file to the working directory.}
  14. \item{FileName}{Character string; an optional argument to specify the name given to the output file. Default is "Transect Coordinates".}
  15. }
  16. \details{Input dataset, LoadDat, should contain separate columns for latitudes and longitudes, named 'start.lat' and 'start.long' respectively. Coordinates should be in decimal degrees.}
  17. \value{A new csv file containing the new end coordinate data appended to the original data.}
  18. \author{Helen Phillips}
  19. \seealso{\code{\link[MODISTools:MODISTransects]{MODISTransects}} \code{\link[MODISTools:ConvertToDD]{ConvertToDD}}}
  20. \examples{
  21. data(EndCoordinatesExample)
  22. EndCoordinates(LoadDat=EndCoordinatesExample,
  23. Distance = 2000, Angle = 90, AngleUnits = 'degrees')
  24. }