Diff of /man/save_multilayer.Rd [000000] .. [9abfcf]

Switch to unified view

a b/man/save_multilayer.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/hummus_objet.R
3
\name{save_multilayer}
4
\alias{save_multilayer}
5
\title{Save multilayer object files in a hierarchical structure on disk}
6
\usage{
7
save_multilayer(hummus, folder_name, verbose = TRUE, suffix = ".tsv")
8
}
9
\arguments{
10
\item{hummus}{A hummus object}
11
12
\item{folder_name}{The name of the folder to save the multilayer}
13
14
\item{verbose}{(integer) - Display function messages. Set to 0 for no
15
message displayed, >= 1 for more details.}
16
17
\item{suffix}{The suffix of the files to save. Default: ".tsv"}
18
}
19
\value{
20
Nothing, but create a folder containing the multilayer object files
21
}
22
\description{
23
Save multilayer files from a Hummus_Object
24
in a hierarchical structure on disk, inside a folder specified through
25
folder_name
26
}
27
\examples{
28
folder_name = "multilayer"
29
save_multilayer(hummus = hummus, folder_name = "multilayer")
30
31
}