janno: janno S3 data type

In poseidon-framework/poseidonR: Poseidon .janno file handling in R

janno S3 data type

Description

The janno S3 class provides a data structure derived from tibble to represent the content of Poseidon .janno files in R.

Usage

as.janno(x, source_janno_file = NA_character_, ...)

## S3 method for class 'janno'
format(x, ...)

## S3 method for class 'janno'
print(x, only_header = FALSE, ...)

read_janno(path, to_janno = TRUE, validate = TRUE)

validate_janno(path)

write_janno(x, path, remove_source_file_column = TRUE)

flatten_janno(x)

Arguments

x	an object
source_janno_file	character. Path to the source .janno file.
...	further arguments passed to or from other methods
only_header	logical. Should only the header be printed.
path	character vector. Paths to one or multiple .janno files or directories that should be recursively searched for .janno files
to_janno	logical. Should the read function transform the input file to a janno object
validate	logical. Run the file validation as part of the reading process
remove_source_file_column	Should the special column source_file be removed from the janno object before writing?

Details

flatten_janno transforms list columns to string lists (separated by ;)

poseidon-framework/poseidonR documentation built on March 15, 2024, 12:18 a.m.