hype_info: Print More Detail About a Hypergraph

Description Usage Arguments Details Examples

View source: R/class_definition.R

Description

Get a more detailed printout of what is contained within a hypergraph object to understand more about its structure as a whole without having to repeatedly call other functions.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
hype_info(
  hype,
  numv = TRUE,
  elist = TRUE,
  vnames = TRUE,
  vweights = TRUE,
  enames = TRUE,
  eweights = TRUE,
  weighted = TRUE,
  oriented = TRUE,
  directed = TRUE,
  real_coef = TRUE,
  inc_mat = TRUE
)

Arguments

hype

A hypergraph object

numv

A logical variable indicating whether information about the number of vertices should be printed

elist

A logical variable indicating whether information about the hyperedge list should be printed

vnames

A logical variable indicating whether information about the vertex names should be printed

vweights

A logical variable indicating whether information about the vertex weights should be printed

enames

A logical variable indicating whether information about the hyperedge names should be printed

eweights

A logical variable indicating whether information about the hyperedge weights should be printed

weighted

A logical variable indicating whether information about the hypergraph weighting should be printed

oriented

A logical variable indicating whether information about the hypergraph orientation should be printed

directed

A logical variable indicating whether information about the hypergraph direction should be printed

real_coef

A logical variable indicating whether information about the hypergraph real coefficients should be printed

inc_mat

A logical variable indicating whether information about the hypergraph incidence matrix should be printed

Details

This gives a more detailed look at the whole hypegraph object. It is intended solely to aid the user when using rhype and generally should not be included in final scripts. If a user wants to include this in their final script it is instead heavily encouraged that they use other rhype functions to generate their own bespoke messages.

Examples

1
2
3
4
5
6
7
8
hype1 <- example_hype()
hype_info(hype1)

hype2 <- example_hype(vertex_weighted = TRUE, edge_weighted = TRUE)
hype_info(hype2)

hype3 <- example_hype(oriented = TRUE, directed = TRUE, real_coef = TRUE)
hype_info(hype3)

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