file_name: Obtain a descriptive filename for a tidycpt object

View source: R/class-tidycpt.R

file_nameR Documentation

Obtain a descriptive filename for a tidycpt object

Description

Obtain a descriptive filename for a tidycpt object

Usage

file_name(x, data_name_slug = "data")

Arguments

x

A tidycpt object

data_name_slug

character string that will identify the data set used in the file name

Details

file_name() generates a random, unique string indicating the algorithm and fitness() for a tidycpt object.

Value

A character string giving a unique file name.

Examples

# Generate a unique name for the file
DataCPSim |>
  segment(method = "pelt") |>
  file_name()

tidychangepoint documentation built on April 4, 2025, 4:31 a.m.