~ubuntu-branches/ubuntu/utopic/r-cran-slam/utopic

« back to all changes in this revision

Viewing changes to man/foreign.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2011-04-16 11:18:27 UTC
  • mfrom: (1.1.19 upstream)
  • Revision ID: james.westby@ubuntu.com-20110416111827-3hulocjqoel3kh5o
Tags: 0.1-22-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\name{foreign}
 
2
\alias{read_stm_CLUTO}
 
3
\alias{write_stm_CLUTO}
 
4
\title{Read and Write Sparse Matrix Format Files}
 
5
\description{
 
6
  Read and write CLUTO sparse matrix format files.
 
7
}
 
8
\usage{
 
9
read_stm_CLUTO(file)
 
10
write_stm_CLUTO(x, file)
 
11
}
 
12
\arguments{
 
13
  \item{file}{a character string with the name of the file to read or
 
14
    write.}
 
15
  \item{x}{a matrix object.}
 
16
}
 
17
\details{
 
18
  Documentation for CLUTO including its sparse matrix format is
 
19
  available from \url{http://www-users.cs.umn.edu/~karypis/cluto/}.
 
20
 
 
21
  \code{read_stm_CLUTO} reads CLUTO sparse matrices, returning a
 
22
  \link[slam:matrix]{simple triplet matrix}.
 
23
 
 
24
  \code{write_stm_CLUTO} writes CLUTO sparse matrices.
 
25
  Argument \code{x} must be coercible to a simple triplet matrix via
 
26
  \code{\link[slam:matrix]{as.simple_triplet_matrix}}.
 
27
}
 
28
\keyword{IO}