build_filename: Module to infer names of .csv files based on metadata+key or...

View source: R/paths.R

build_filenameR Documentation

Module to infer names of .csv files based on metadata+key or experiment_folder+key Build a filename based on the metadata and a key

Description

Module to infer names of .csv files based on metadata+key or experiment_folder+key Build a filename based on the metadata and a key

Usage

build_filename(
  result_folder,
  metadata,
  key = NULL,
  suffix = "",
  extension = ".csv"
)

Arguments

result_folder

Path to a folder where to save results. If not passaed, it is set to experiment_folder

metadata

data.table with all information about the experiment i.e. when it was done, etc

key

Name of a table in the resulting database

suffix

A character (word) that will differentiate resulting output from other output produced on the same experiment folder. Useful for segmenting the experiment into different periods of interest and analyzing these periods separately.

extension

Extension of file (.csv, ...)

Value

Filename with systematic metainformation and key to differentiate it from other files from the same experiment


shaliulab/idocr documentation built on June 1, 2025, 4:59 p.m.