write_motifs: Export motifs in universalmotif format.

Description Usage Arguments Value Author(s) See Also

View source: R/write_motifs.R

Description

Write motifs as universalmotif objects to file. For optimal storage of universalmotif class motifs, consider using saveRDS() and readRDS(). Currently the universalmotif format is YAML-based, but this is subject to change.

Usage

1
2
write_motifs(motifs, file, minimal = FALSE, multifreq = TRUE,
  progress = FALSE, overwrite = FALSE, append = FALSE, BP = FALSE)

Arguments

motifs

See convert_motifs() for acceptable formats.

file

character(1) File name.

minimal

logical(1) Only write essential motif information.

multifreq

logical(1) Write multifreq slot, if present.

progress

logical(1) Show progress.

overwrite

logical(1) Overwrite existing file.

append

logical(1) Add to an existing motif file. Package version in existing motif file must be greater than 1.2.0.

BP

logical(1) Allows for the use of BiocParallel within write_motifs(). See BiocParallel::register() to change the default backend.

Value

NULL, invisibly.

Author(s)

Benjamin Jean-Marie Tremblay, b2tremblay@uwaterloo.ca

See Also

Other write_motifs: write_homer(), write_jaspar(), write_matrix(), write_meme(), write_transfac()


bjmt/universalmotif documentation built on Sept. 26, 2020, 3:09 a.m.