tolist: To list

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/Tools.R

Description

Create a file containing a list with the directories of maps. This file can be used in Timesat or with the function ExtractFile.

Usage

1
tolist(ndvidirectory, region, Ystart, Yend, outfile = "list.txt", type = "VITO_CLIP")

Arguments

ndvidirectory

path to the ndvi images folder (GeoTIFF files).
Please note that paths to files in R can be specified with either "/" or "\\" in Windows OS and with "/" in UNIX OS.

region

name of the region, same as in the name of the ndvi images.
Please refer to details section for more information on the nomenclature.

Ystart

starting year of the analysis (in four-digit format).

Yend

ending year of the analysis (in four-digit format).

outfile

name of the file where the list is saved (extenstion ".txt"). By default, outfile="list.txt".

type

type of nomenclature followed by the NDVI images : "VITO_CLIP", "VITO_VGT" or "GIMMS" (see details for more information).
By default, type = "VITO_CLIP".

Details

The format of the output file is as follows:
N
path\image1.tif
path\image2.tif
...
path\imageN.tif
with N the number of image files.
File names of image are in chronological order. It is important, for further utilisation, that ndvidirectory include the complete path to the file.

More about the variable type :
type = GIMMS : nomenclature from Global Land Cover Facility
[RE][YY][MMM][DDD].[SAT]-VIg.tif

type = VITO_VGT : FreeVGT VITO's nomenclature
NDV_[YYYYMMDD]_[REGION]_Extract.tif

type = VITO_CLIP : nomenclature after clipping the images in a particular region.
[REGION][YYYY]M[MM]P[D].tif

Value

Nothing return.

Author(s)

Romain Frelat and Bruno Gerard

References

Jonsson, P. and Eklundh, L. 2004, Computers & Geosciences, TIMESAT a program for analyzing time-series of satellite sensor data, 30, 833–845

See Also

ExtractFile

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#local variables
ndvidirectory=paste(system.file("extdata/VITO_Mzimba",
    package="ndvits"), "/", sep="")
region="Mzimba"
Ystart=2004
Yend=2009

#executing tolist
tolist(ndvidirectory, region, Ystart, Yend, 
    , outfile="MzimbaList.txt") 

ndvits documentation built on May 31, 2017, 2:06 a.m.