Skip to contents

Utility function to convert existing RDS databases to JSON format. Can convert a single file or batch convert all RDS files in a directory.

Usage

boilerplate_rds_to_json(
  input_path,
  output_path = NULL,
  pretty = TRUE,
  quiet = FALSE
)

Arguments

input_path

Path to RDS file or directory containing RDS files

output_path

Path to save JSON files. If NULL, saves in same location as input with .json extension.

pretty

Pretty print JSON for readability? Default is TRUE.

quiet

Suppress messages? Default is FALSE.

Value

Invisible TRUE on success

Details

This function is useful for migrating existing RDS-based databases to the more portable JSON format. JSON files are human-readable, work well with version control, and can be used across different programming languages.

See also

boilerplate_migrate_to_json for full migration workflow

Examples

# \donttest{
# Create temporary directory for example
temp_dir <- tempfile()
dir.create(temp_dir)

# Create sample RDS file
sample_db <- list(methods = list(sampling = "Random sampling"))
saveRDS(sample_db, file.path(temp_dir, "methods_db.rds"))

# Convert single file
boilerplate_rds_to_json(file.path(temp_dir, "methods_db.rds"))
#>  Converted to /var/folders/q9/lkcn14l97mb6mkhbxsxrpr4w0000gn/T//RtmpyUdfgu/filea2add79be8d/methods_db.json

# Convert all RDS files in directory
boilerplate_rds_to_json(temp_dir)
#>  Converting methods_db.rds
#>  Created methods_db.json

# Convert to different location
output_dir <- tempfile()
dir.create(output_dir)
boilerplate_rds_to_json(temp_dir, output_path = output_dir)
#>  Converting methods_db.rds
#>  Created methods_db.json

# Clean up
unlink(temp_dir, recursive = TRUE)
unlink(output_dir, recursive = TRUE)
# }