graphreport/README.Rmd at master · karpfen/graphreport · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
output: rmarkdown::github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r opts, echo = FALSE}
knitr::opts_chunk$set(
                      collapse = TRUE,
                      warning = TRUE,
                      message = TRUE,
                      width = 120,
                      comment = "#>"
                      )
```

[![Build Status](https://travis-ci.org/karpfen/graphreport.svg?branch=master)](https://travis-ci.org/karpfen/graphreport)
[![Build status](https://ci.appveyor.com/api/projects/status/rntig857s7ephl78?svg=true)](https://ci.appveyor.com/project/karpfen/graphreport)
[![codecov](https://codecov.io/gh/karpfen/graphreport/branch/master/graph/badge.svg)](https://codecov.io/gh/karpfen/graphreport)

# graphreport

R package for generating reports about graphs.

------

## Install

```{r, eval=FALSE}
devtools::install_github ('karpfen/graphreport')
```

## Usage

```{r, eval=FALSE}
# create random sample graph with 50 edges
n <- 50
from <- as.integer (runif (min = 0, max = 100, n))
to <- as.integer (runif (min = 0, max = 100, n))
weight <- runif (n)
graph <- data.frame (from, to, weight)
```

### Generating a complete graph report

```{r, eval=FALSE}
generate_graph_report (graph)
```


### Getting individual graph statistics

```{r, eval=FALSE}
sizes <- get_graph_sizes (graph)
length (sizes) # print the number of graphs
sizes # print the size of every graph

degrees <- get_node_degrees (graph)
summary (degrees)

get_edge_weight_summary (graph, 5)
```

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/karpfen/graphreport/blob/master/CONDUCT.md). By participating in this project you agree to abide by its terms.