|
a |
|
b/man/define_general_config.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/explore_network.R |
|
|
3 |
\name{define_general_config} |
|
|
4 |
\alias{define_general_config} |
|
|
5 |
\title{Define general config file for hummuspy} |
|
|
6 |
\usage{ |
|
|
7 |
define_general_config( |
|
|
8 |
hummus_object, |
|
|
9 |
multiplex_names = NULL, |
|
|
10 |
bipartites_names = NULL, |
|
|
11 |
folder_multiplexes = "multiplex", |
|
|
12 |
folder_bipartites = "bipartites", |
|
|
13 |
seed_path = "seed/seeds.txt", |
|
|
14 |
suffix = ".tsv", |
|
|
15 |
self_loops = FALSE, |
|
|
16 |
restart_proba = 0.7, |
|
|
17 |
save_configfile = FALSE, |
|
|
18 |
config_name = "config.yml", |
|
|
19 |
config_folder = "config", |
|
|
20 |
multilayer_f = "multilayer", |
|
|
21 |
suffix_bipartites = ".tsv" |
|
|
22 |
) |
|
|
23 |
} |
|
|
24 |
\arguments{ |
|
|
25 |
\item{hummus_object}{A hummus object} |
|
|
26 |
|
|
|
27 |
\item{multiplex_names}{A vector of multiplex names considered. |
|
|
28 |
It must be a subset of the names of the multiplexes in the hummus object, or NULL |
|
|
29 |
if all multiplexes should be considered.} |
|
|
30 |
|
|
|
31 |
\item{bipartites_names}{A vector of bipartites names considered. |
|
|
32 |
It must be a subset of the names of the bipartites in the hummus object, or NULL |
|
|
33 |
if all bipartites should be considered.} |
|
|
34 |
|
|
|
35 |
\item{folder_multiplexes}{The folder where the multiplexes are stored} |
|
|
36 |
|
|
|
37 |
\item{folder_bipartites}{The folder where the bipartites are stored} |
|
|
38 |
|
|
|
39 |
\item{seed_path}{The path to the seed file} |
|
|
40 |
|
|
|
41 |
\item{self_loops}{A boolean indicating if self loops should be considered.} |
|
|
42 |
|
|
|
43 |
\item{restart_proba}{The restart probability for the random walk (default = 0.7)} |
|
|
44 |
|
|
|
45 |
\item{save_configfile}{A boolean indicating if the config file should be saved} |
|
|
46 |
|
|
|
47 |
\item{config_name}{The name of the config file to be created by hummuspy} |
|
|
48 |
|
|
|
49 |
\item{config_folder}{The folder where the config file will be created (inside multilayer_f)} |
|
|
50 |
|
|
|
51 |
\item{multilayer_f}{The folder where the multilayer is stored} |
|
|
52 |
|
|
|
53 |
\item{suffix_bipartites}{A suffix to add to the bipartites names (to indicate |
|
|
54 |
the exact file name)} |
|
|
55 |
} |
|
|
56 |
\value{ |
|
|
57 |
A config file for hummuspy |
|
|
58 |
} |
|
|
59 |
\description{ |
|
|
60 |
Define general config file for hummuspy |
|
|
61 |
} |