File: read_graph.Rd

package info (click to toggle)
r-cran-igraph 1.0.1-1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 18,232 kB
  • sloc: ansic: 173,538; cpp: 19,365; fortran: 4,550; yacc: 1,164; tcl: 931; lex: 484; makefile: 149; sh: 9
file content (60 lines) | stat: -rw-r--r-- 1,946 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/foreign.R
\name{read_graph}
\alias{DL}
\alias{GML}
\alias{GraphML}
\alias{LGL}
\alias{Pajek}
\alias{UCINET}
\alias{read.graph}
\alias{read_graph}
\title{Reading foreign file formats}
\usage{
read_graph(file, format = c("edgelist", "pajek", "ncol", "lgl", "graphml",
  "dimacs", "graphdb", "gml", "dl"), ...)
}
\arguments{
\item{file}{The connection to read from. This can be a local file, or a
\code{http} or \code{ftp} connection. It can also be a character string with
the file name or URI.}

\item{format}{Character constant giving the file format. Right now
\code{as_edgelist}, \code{pajek}, \code{graphml}, \code{gml}, \code{ncol},
\code{lgl}, \code{dimacs} and \code{graphdb} are supported, the default is
\code{edgelist}. As of igraph 0.4 this argument is case insensitive.}

\item{\dots}{Additional arguments, see below.}
}
\value{
A graph object.
}
\description{
The \code{read_graph} function is able to read graphs in various
representations from a file, or from a http connection. Currently some
simple formats are supported.
}
\details{
The \code{read_graph} function may have additional arguments depending on
the file format (the \code{format} argument). See the details separately for
each file format, below.
}
\section{Edge list format}{
 This format is a simple text file with numeric
vertex ids defining the edges. There is no need to have newline characters
between the edges, a simple space will also do.

Additional arguments: \describe{ \item{n}{The number of vertices in the
graph. If it is smaller than or equal to the largest integer in the file,
then it is ignored; so it is safe to set it to zero (the default).}
\item{directed}{Logical scalar, whether to create a directed graph. The
default value is \code{TRUE}.} }
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\seealso{
\code{\link{write_graph}}
}
\keyword{graphs}