Version 0.7

LaF/DESCRIPTION

@@ -1,7 +1,7 @@
 Package: LaF
 Type: Package
 Title: Fast access to large ASCII files
-Version: 0.6
+Version: 0.7
 Date: 2014-03-22
 Author: Jan van der Laan
 Maintainer: Jan van der Laan <[email protected]>

LaF/NEWS

@@ -1,6 +1,6 @@
 
 
-LaF version 0.6
+LaF version 0.7
 ===============================================================================
 * Internal changes: switched documentation to roxygen; changes to namespace and
   description files to pass tests.

LaF/man/indexing.Rd

@@ -0,0 +1,30 @@
+\docType{methods}
+\name{[,laf_column-method}
+\alias{[,laf-method}
+\alias{[,laf_column-method}
+\title{Read records from a large file object into R}
+\usage{
+\S4method{[}{laf_column}(x, i, j, drop)
+
+\S4method{[}{laf}(x, i, j, drop)
+}
+\arguments{
+  \item{x}{an object of type
+  \code{"\link[=laf-class]{laf}"} or
+  \code{"\link[=laf_column-class]{laf_column}"}.}
+
+  \item{i}{an logical or numeric vector with indices. The
+  rows which should be selected.}
+
+  \item{j}{a numeric vector with the columns to select.}
+
+  \item{drop}{a logical indicating whether or not to
+  convert the result to a vector when only one column is
+  selected. As in when indexing a \code{data.frame}.}
+}
+\description{
+When a connection is opened to a
+\code{"\link[=laf-class]{laf}"} object; this object can
+then be indexed roughly as one would a \code{data.frame}.
+}
+

LaF/man/laf-class.Rd

@@ -0,0 +1,26 @@
+\docType{class}
+\name{laf-class}
+\alias{laf-class}
+\title{Large File object}
+\description{
+A Large File object. This is a reference to a dataset on
+disk. The data itself is not read into memory (yet). This
+can be done by the methods for blockwise processing or by
+indexing the object as a data.frame. The code has been
+optimised for fast access.
+}
+\section{Objects from the Class}{
+  Objects can be created by opening a file using one of the
+  methods \code{\link{laf_open_csv}} or
+  \code{\link{laf_open_fwf}}. These create a reference to
+  either a CSV file or a fixed width file. The data in
+  these files can either be accessed using blockwise
+  operations using the methods \code{begin},
+  \code{next_block} and \code{goto}. Or by indexing the laf
+  object as you would a data.frame. In the following
+  example a CSV file is opened and its first column (of
+  type integer) is read into memory: \preformatted{ laf <-
+  laf_open_csv("file.csv", column_types=c("integer",
+  "double")) data <- laf[ , 1] }
+}
+

LaF/man/laf_column-class.Rd

@@ -0,0 +1,17 @@
+\docType{class}
+\name{laf_column-class}
+\alias{laf_column-class}
+\title{Column of a Large File Object}
+\description{
+Representation of a column in a Large File object. This
+class itself is a subclass of the class \code{laf}. In
+principle all methods that can be used with a \code{laf}
+object can also be used with a \code{laf_column} object
+except the the \code{column} or \code{columns} arguments of
+these methods are not needed.
+}
+\section{Objects from the Class}{
+  Object of this class are usually created by using the
+  \code{$} operator on \code{laf} objects.
+}
+