Skip to contents

Rehash RDS Files in a Directory

Source: R/rehash.R
rehash.Rd

This function processes all RDS files in a specified directory, generating new hashes for each file's args_list and renaming the files accordingly. It's useful when changing the hash generation algorithm or parameters (if the parameters are manually changed for some reason).

Usage

rehash(
  folder,
  hash_includes_timestamp = FALSE,
  ignore_na = TRUE,
  alphabetical_order = TRUE,
  algo = "xxhash64"
)

Arguments

folder

A string specifying the directory containing the RDS files to be rehashed.

hash_includes_timestamp

Logical; if TRUE, includes timestamps in the hash generation.

ignore_na

Logical; if TRUE, NA values are ignored during hash generation.

alphabetical_order

Logical; if TRUE, parameters are sorted alphabetically before hash generation.

algo

The (potentially new) hash algorithm to use (see ?digest)

Value

The function does not return a value but renames the RDS files in the specified directory based on new hashes.

Examples

## Setup
tmp_dir <- file.path(tempdir(), "example")
dir.create(tmp_dir)

# Save example objects
obj1 <- rnorm(1000)
obj2 <- data.frame(
  x = runif(100),
  y = "something",
  z = rep(c(TRUE, FALSE), 50)
)
obj3 <- list(obj1, obj2)

params1 <- list(
  distribution = "normal",
  other_params = list(param1 = TRUE, param2 = 1, param3 = NA)
)
params2 <- list(
  distribution = "uniform",
  other_params = list(param1 = FALSE, param2 = 2, param3 = "1", param4 = 4)
)
params3 <- list(
  distribution = "composite",
  other_params = list(param1 = TRUE, param2 = 3, param3 = 1)
)

save_objects(tmp_dir, obj1, params1)
save_objects(tmp_dir, obj2, params2)
save_objects(tmp_dir, obj3, params3)

## See current file names
list.files(tmp_dir)
#> [1] "3ad8d8534a75f850.rds" "40650b573a1cf710.rds" "b4d0ab79d10e4e7b.rds"
#> [4] "indexr.yaml"          "indexr.yaml.lock"    

## Rehash with new algo
rehash(tmp_dir, algo = "xxhash32")
#> Rehashed 'b4d0ab79d10e4e7b' -> '549d733e' via YAML (algo=xxhash32).
#> Rehashed '40650b573a1cf710' -> 'a919749f' via YAML (algo=xxhash32).
#> Rehashed '3ad8d8534a75f850' -> '3178c5d7' via YAML (algo=xxhash32).

## Observe new file names
list.files(tmp_dir)
#> [1] "3178c5d7.rds"     "549d733e.rds"     "a919749f.rds"     "indexr.yaml"     
#> [5] "indexr.yaml.lock"

## Cleanup
unlink(tmp_dir, recursive = TRUE)