sim_write: Write similarity matrix.

View source: R/sim_read-write.R

sim_writeR Documentation

Write similarity matrix.

Description

sim_write writes similarity matrix.

Usage

sim_write(sim_df, output, file_format = "parquet")

Arguments

sim_df

metric_sim object.

output

character string specifying the output directory or filename.

file_format

character string specify file format. This must be one of csv or parquet(default).

Details

The output format can be either CSV or Parquet.

With the CSV format, the row_metadata and metric_metadata attributes are saved as separate files.

This is not required for Parquet because it saves the attributes as well.

Value

No return value, called for side effects

Examples

suppressMessages(suppressWarnings(library(magrittr)))
population <- tibble::tibble(
  Metadata_group = sample(c("a", "b"), 4, replace = TRUE),
  x = rnorm(4),
  y = x + rnorm(4) / 100,
  z = y + rnorm(4) / 1000
)
tmpdir <- tempdir()
tmpfile_prefix <- file.path(tmpdir, "test")
sim_df <- matric::sim_calculate(population, method = "pearson")
sim_df %>% matric::sim_write(tmpfile_prefix, file_format = "csv")
readr::read_csv(file.path(tmpfile_prefix, "test.csv"))
readr::read_csv(file.path(tmpfile_prefix, "test_metadata.csv"))
jsonlite::read_json(file.path(tmpfile_prefix, "test_metadata.json"))
sim_df %>% matric::sim_write(paste0(tmpfile_prefix, ".parquet"))
sim_df_in <- arrow::read_parquet(paste0(tmpfile_prefix, ".parquet"))
attr(sim_df_in, "row_metadata")
attr(sim_df_in, "metric_metadata")

matric documentation built on April 1, 2023, 12:19 a.m.