Skip to contents

Manage cached files from the censobr package

Source: R/censobr_cache.R
censobr_cache.Rd

Manage cached files from the censobr package

Usage

censobr_cache(list_files = TRUE, delete_file = NULL)

Arguments

list_files

Logical. Whether to print a message with the address of all censobr data sets cached locally. Defaults to TRUE.

delete_file

String. The file name (basename) of a censobr data set cached locally that should be deleted. Defaults to NULL, so that no file is deleted. If delete_file = "all", then all cached censobr files are deleted.

Value

A message indicating which file exist and/or which ones have been deleted from local cache directory.

See also

Other Cache data: set_censobr_cache_dir()

Examples

# list all files cached
censobr_cache(list_files = TRUE)
#> Files currently chached:
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/1980_dictionary_microdata_households.html
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2000_families_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_dictionary_microdata_population.html
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_dictionary_tracts.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_emigration_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_households_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_interview_manual.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_mortality_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_population_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_questionnaire_long.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_Basico_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_Domicilio_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_PessoaRenda_v0.3.0.parquet

# delete particular file
censobr_cache(delete_file = '2010_deaths')
#> The file '2010_deaths' is not cached.
#> Files currently chached:
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/1980_dictionary_microdata_households.html
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2000_families_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_dictionary_microdata_population.html
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_dictionary_tracts.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_emigration_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_households_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_interview_manual.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_mortality_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_population_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_questionnaire_long.pdf
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_Basico_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_Domicilio_v0.3.0.parquet
#> /home/runner/.cache/R/censobr/data_release_v0.3.0/2010_tracts_PessoaRenda_v0.3.0.parquet