Options: Options for package 'inepdata'

Description Usage Arguments Examples

Description

Options for package inepdata

Usage

1
2
Options(..., zip.path, offline, download.page.url, temp.path, keep.download,
  verbose)

Arguments

...

these dots are here just to force parameters to be explicitly named

zip.path

paths to directories where the downloaded zip files are located, so that those zip files will not be downloaded if available locally. If you are not going to work with already downloaded ZIP files, then set zip.path to NULL or to "".

**Important**: the filenames must be equal to the corresponding file in INEP site.

Default value: `""`
offline

whether you want to work only with ZIP files already downloaded at zip.path or work scrape ZIP file links in INEP microdata download page at download.page.url. If offline is TRUE, then zip.path will need to be set to a value other than ""

Default value: `FALSE`
download.page.url

external HTML page from which the ZIP URLs will be scraped if offline is false. It is there just in case the package fails to fetch the correct URL from INEP's site – which can occur when INEP alters its site structure, for instance. (Should you detect this kind of occurrence, please contact this package's author, just in case he haven't noticed that yet.) If you want download.page.url back to its default value, then set download.page.url to NULL or to "".

Default Value: `"http://portal.inep.gov.br/web/guest/microdados"`
temp.path

where should the microdata ZIP files be downloaded and decompressed? It cannot be set "" and, if attempted, it is set to its default value "./temp".

Default value: `"./temp"`
keep.download

whether to keep or purge the downloaded packed microdata files

Default value: `FALSE`
verbose

do you want know what is going on under the hood while these functions are running?

 Default value: `FALSE`

Examples

1
2
3
4
5
6
7
8
# in case INEP microdata download page changes:
options(download.page.url = "http://inep.hypothetical.new.page/microdata")
# if you have part of your data already downloaded
options(zip.path = "./zipfiles.I.already.downloaded/")
# if you only want to work with the data you already downloaded, without looking at INPE's page
options(download.page.url = "", zip.path = "./zipfiles.I.already.downloaded/") #
options(temp.path = "/tmp/")     # Unix example
options(keep.download = TRUE, temp.path = "./store.zip.files.here/")

zyxdef/inepdata documentation built on May 8, 2019, 11:59 p.m.