fetch_quant: fetch the compressed quantification result of a specific...

In COMBINE-lab/roe: R utilities for alevin-fry

fetch the compressed quantification result of a specific dataset and stroe the path to the tar file in the tar_path slot of the returned processed_quant list. This function must be run after ProcessedQuant()

Description

fetch the compressed quantification result of a specific dataset and stroe the path to the tar file in the tar_path slot of the returned processed_quant list. This function must be run after ProcessedQuant()

Usage

fetch_quant(
  processed_quant,
  tar_dir = "quant_tar",
  tar_name = NULL,
  force = FALSE,
  quiet = FALSE
)

Arguments

processed_quant	a ProcessedQuant class object recording the details of a dataset, which is nitialized by running ProcessedQuant(dataset_id)
tar_dir	a string to a path where the fetched tar files will be stored. It will be created if does not exist.
tar_name	a string indicates the name of the tar file. If NULL, the dataset_id will be used as the file name.
force	logic whether to proceed if the tar file exists.
quiet	logical whether to display no messages

Value

A ProcessedQuant class object with a updated tar_path slot.

COMBINE-lab/roe documentation built on Nov. 8, 2022, 5:23 p.m.