example_hype: Generate an Example Hypergraph

Description Usage Arguments Value Examples

View source: R/example_hype.R

Description

Quickly generate an example hypergraph. Can be used for quickly testing and trialing examples.

Usage

1
2
3
4
5
6
7
example_hype(
  oriented = FALSE,
  directed = FALSE,
  vertex_weighted = FALSE,
  edge_weighted = FALSE,
  real_coef = FALSE
)

Arguments

oriented

Logical value representing whether the example hypergraph should be oriented

directed

Logical value representing whether the example hypergraph should be directed

vertex_weighted

Logical value representing whether the example hypergraph should have vertex weights

edge_weighted

Logical value representing whether the example hypergraph should have hyperedge weights

real_coef

Logical value representing whether the example hypergraph should have real coefficients relating vertices to hyperedges

Value

An example hypergraph with the given properties

Examples

1
2
3
4
h1 <- example_hype()
h2 <- example_hype(oriented = TRUE)
h3 <- example_hype(oriented = TRUE, directed = TRUE)
h4 <- example_hype(oriented = TRUE, directed = TRUE, real_coef = TRUE)

rhype documentation built on Nov. 9, 2021, 9:06 a.m.