sc_atac_create_report: HTML report generation

View source: R/sc_atac_create_report.R

sc_atac_create_reportR Documentation

HTML report generation

Description

Generates a HTML report using the output folder produced by the pipeline

Usage

sc_atac_create_report(
  input_folder,
  output_folder = NULL,
  organism = NULL,
  sample_name = NULL,
  feature_type = NULL,
  n_barcode_subset = 500
)

Arguments

input_folder

The path of the folder produced by the pipeline

output_folder

The path of the output folder to store the HTML report in

organism

A string indicating the name of the organism being analysed

sample_name

A string indicating the name of the sample

feature_type

A string indicating the type of the feature ('genome_bin' or 'peak')

n_barcode_subset

if you require only to visualise stats for a sample of barcodes to improve processing time (integer)

Value

the path of the output file


LuyiTian/scPipe documentation built on Dec. 11, 2023, 8:21 p.m.