Skip to content

Commit 7bf22c8

Browse files
committed
chore: Move README.* to root
1 parent 7cdc7f0 commit 7bf22c8

File tree

4 files changed

+44
-44
lines changed

4 files changed

+44
-44
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
^igraphdata\.Rproj$
88
^\.Rproj\.user$
99
^\.github$
10+
^README\.Rmd$

inst/README.Rmd README.Rmd

File renamed without changes.

README.md

-1
This file was deleted.

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!-- README.md is generated from README.Rmd. Please edit that file -->
2+
3+
# Data sets for the igraph R package
4+
5+
[![Linux build status](https://travis-ci.org/igraph/igraphdata.png)](https://travis-ci.org/igraph/igraphdata) [![Windows build status](https://ci.appveyor.com/api/projects/status/6wov9hh8oprrpkhs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/igraphdata)
6+
7+
This is a data R package, that contains network data sets, to be used with the igraph R package.
8+
9+
## Installation
10+
11+
From CRAN:
12+
13+
<pre class='chroma'>
14+
<span><span class='nf'><a href='https://rdrr.io/r/utils/install.packages.html'>install.packages</a></span><span class='o'>(</span><span class='s'>"igraphdata"</span><span class='o'>)</span></span></pre>
15+
16+
You can install the development version from Github, using the [devtools package](https://github.com/hadley/devtools):
17+
18+
<pre class='chroma'>
19+
<span><span class='nf'>devtools</span><span class='nf'>::</span><span class='nf'><a href='https://remotes.r-lib.org/reference/install_github.html'>install_github</a></span><span class='o'>(</span><span class='s'>"igraph/igraphdata"</span><span class='o'>)</span></span></pre>
20+
21+
## Usage
22+
23+
<pre class='chroma'>
24+
<span><span class='kr'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='o'>(</span><span class='nv'><a href='http://igraph.org'>igraphdata</a></span><span class='o'>)</span></span>
25+
<span><span class='nf'><a href='https://rdrr.io/r/utils/data.html'>data</a></span><span class='o'>(</span>package <span class='o'>=</span> <span class='s'>"igraphdata"</span><span class='o'>)</span></span></pre>
26+
<pre class='chroma'>
27+
<span><span class='c'>#&gt; Data sets in package 'igraphdata':</span></span>
28+
<span><span class='c'>#&gt; </span></span>
29+
<span><span class='c'>#&gt; Koenigsberg Bridges of Koenigsberg from Euler's times</span></span>
30+
<span><span class='c'>#&gt; UKfaculty Friendship network of a UK university faculty</span></span>
31+
<span><span class='c'>#&gt; USairports US airport network, 2010 December</span></span>
32+
<span><span class='c'>#&gt; enron Enron Email Network</span></span>
33+
<span><span class='c'>#&gt; foodwebs A collection of food webs</span></span>
34+
<span><span class='c'>#&gt; immuno Immunoglobulin interaction network</span></span>
35+
<span><span class='c'>#&gt; karate Zachary's karate club network</span></span>
36+
<span><span class='c'>#&gt; kite Krackhardt's kite</span></span>
37+
<span><span class='c'>#&gt; macaque Visuotactile brain areas and connections</span></span>
38+
<span><span class='c'>#&gt; rfid Hospital encounter network data</span></span>
39+
<span><span class='c'>#&gt; yeast Yeast protein interaction network</span></span></pre>
40+
41+
# License
42+
43+
CC BY-SA 4.0, plus see [LICENSE](LICENSE) for the licenses of the individual data sets.

inst/README.md

-43
This file was deleted.

0 commit comments

Comments
 (0)