caged_download: Baixa microdados do CAGED do repositório HuggingFace

View source: R/download.R

caged_downloadR Documentation

Baixa microdados do CAGED do repositório HuggingFace

Description

Baixa os arquivos ⁠.7z⁠ para um diretório local, criando uma estrutura de pastas por ano. Arquivos já baixados não são re-baixados (cache local).

Usage

caged_download(
  years,
  months = seq_len(12L),
  states = NULL,
  destdir = NULL,
  force = FALSE,
  timeout = 300,
  workers = getOption("datacaged.workers", min(3L, future::availableCores()))
)

Arguments

years

integer vector. Desired years (ex: 2020:2023).

months

integer vector. Desired months (1–12). Default: seq_len(12L) (todos os meses).

states

character vector or NULL. Ignorado — mantido por compatibilidade.

destdir

character or NULL. Local directory to save os arquivos. If NULL, uses the default directory do sistema via tools::R_user_dir("datacaged", "cache").

force

logical. If TRUE, re-downloads files already in cache. Default: FALSE.

timeout

integer. Timeout por arquivo em segundos. Default: 300.

workers

integer. Number of parallel downloads. Default: 3. Use 1 for sequential mode. Controlled via options(datacaged.workers = N).

Details

Para o Novo CAGED (2020+), são baixados três tipos por competência: movimentações (MOV), fora do prazo (FOR) e exclusões (EXC).

Para o CAGED antigo (até 2019), o download é nacional (arquivo único por competência).

Compatibilidade entre plataformas:

Recurso Windows macOS Linux
Download (HTTPS) OK OK OK
Downloads paralelos OK OK OK
Novo CAGED (2020+, LZMA) OK OK OK
CAGED antigo (PPMd) (!) (!) (!)

O CAGED antigo (pré-2020) usa PPMd e requer 7-Zip instalado. O Novo CAGED usa LZMA e funciona em todas as plataformas sem dependências extras.

Value

data.frame invisível com colunas arquivo, competencia, type, uf e status (baixado / cache / nao_encontrado / erro).

See Also

caged_load() para o pipeline completo (download + parse + DuckDB).

caged_hf_files() para listar competências disponíveis no HuggingFace.

Examples

## Not run: 
# Baixa Novo CAGED de jan-mar/2023
manifest <- caged_download(years = 2023, months = c(1L, 2L, 3L))

# Ver status de cada arquivo (baixado / cache / nao_encontrado / erro)
dplyr::count(manifest, status)

# Baixa CAGED antigo de 2018
caged_download(years = 2018)

# Forçar re-download mesmo com cache
caged_download(years = 2023, months = 1, force = TRUE)

# Salvar em diretório personalizado
caged_download(years = 2023, months = 1, destdir = file.path(tempdir(), "caged_cache"))

## End(Not run)


datacaged documentation built on Oct. 13, 2026, 1:06 a.m.