# Memory-Efficient Storage of Large Data on Disk and Fast Access Functions

## Documentation for package ‘ff’ version 4.0.5

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G H I K L M N O P Q R S T U V W Y misc

## -- A --

add | Incrementing an ff or ram object
add.default | Incrementing an ff or ram object
add.ff | Incrementing an ff or ram object
appendLevels | Factor level manipulation
array2vector | Array: make vector from array
arrayIndex2vectorIndex | Array: make vector positions from array index
as.bit.ff | Conversion between bit and ff boolean
as.bit.hi | Hybrid Index, coercing from
as.bitwhich.hi | Hybrid Index, coercing from
as.boolean | Coercing to virtual mode
as.boolean.default | Coercing to virtual mode
as.byte | Coercing to virtual mode
as.byte.default | Coercing to virtual mode
as.character.hi | Hybrid Index, coercing from
as.data.frame.ffdf | Coercing to ffdf and data.frame
as.ff | Coercing ram to ff and ff to ram objects
as.ff.bit | Conversion between bit and ff boolean
as.ff.default | Coercing ram to ff and ff to ram objects
as.ff.ff | Coercing ram to ff and ff to ram objects
as.ffdf | Coercing to ffdf and data.frame
as.ffdf.data.frame | Coercing to ffdf and data.frame
as.ffdf.ff_matrix | Coercing to ffdf and data.frame
as.ffdf.ff_vector | Coercing to ffdf and data.frame
as.hi | Hybrid Index, coercion to
as.hi.( | Hybrid Index, coercion to
as.hi.bit | Hybrid Index, coercion to
as.hi.bitwhich | Hybrid Index, coercion to
as.hi.call | Hybrid Index, coercion to
as.hi.character | Hybrid Index, coercion to
as.hi.double | Hybrid Index, coercion to
as.hi.hi | Hybrid Index, coercion to
as.hi.integer | Hybrid Index, coercion to
as.hi.logical | Hybrid Index, coercion to
as.hi.matrix | Hybrid Index, coercion to
as.hi.name | Hybrid Index, coercion to
as.hi.NULL | Hybrid Index, coercion to
as.hi.ri | Hybrid Index, coercion to
as.hi.which | Hybrid Index, coercion to
as.integer.hi | Hybrid Index, coercing from
as.logical.hi | Hybrid Index, coercing from
as.matrix.hi | Hybrid Index, coercing from
as.nibble | Coercing to virtual mode
as.nibble.default | Coercing to virtual mode
as.quad | Coercing to virtual mode
as.quad.default | Coercing to virtual mode
as.ram | Coercing ram to ff and ff to ram objects
as.ram.default | Coercing ram to ff and ff to ram objects
as.ram.ff | Coercing ram to ff and ff to ram objects
as.short | Coercing to virtual mode
as.short.default | Coercing to virtual mode
as.ubyte | Coercing to virtual mode
as.ubyte.default | Coercing to virtual mode
as.ushort | Coercing to virtual mode
as.ushort.default | Coercing to virtual mode
as.vmode | Coercing to virtual mode
as.vmode.default | Coercing to virtual mode
as.vmode.ff | Coercing to virtual mode
as.which.hi | Hybrid Index, coercing from

## -- B --

bigsample | Sampling from large pools
bigsample.default | Sampling from large pools
bigsample.ff | Sampling from large pools
boolean | Create vector of virtual mode
byte | Create vector of virtual mode

## -- C --

ccbind | Collapsing functions for batch processing
CFUN | Collapsing functions for batch processing
cfun | Collapsing functions for batch processing
chunk.ffdf | Chunk ff_vector and ffdf
chunk.ff_vector | Chunk ff_vector and ffdf
clength | Collapsing functions for batch processing
clone.ff | Cloning ff and ram objects
clone.ffdf | Cloning ffdf objects
close.ff | Closing ff files
close.ffdf | Closing ff files
close.ff_pointer | Closing ff files
cmean | Collapsing functions for batch processing
cmedian | Collapsing functions for batch processing
cquantile | Collapsing functions for batch processing
crbind | Collapsing functions for batch processing
csum | Collapsing functions for batch processing
csummary | Collapsing functions for batch processing

## -- D --

delete | Deleting the file behind an ff object
delete.default | Deleting the file behind an ff object
delete.ff | Deleting the file behind an ff object
delete.ffdf | Deleting the file behind an ff object
delete.ff_pointer | Deleting the file behind an ff object
deleteIfOpen | Deleting the file behind an ff object
deleteIfOpen.ff | Deleting the file behind an ff object
deleteIfOpen.ff_pointer | Deleting the file behind an ff object
dforder | Sorting: convenience wrappers for data.frames
dfsort | Sorting: convenience wrappers for data.frames
dim.ff | Getting and setting dim and dimorder
dim.ffdf | Getting and setting dim and dimorder
dim<-.ff | Getting and setting dim and dimorder
dim<-.ffdf | Getting and setting dim and dimorder
dimnames.ff | Getting and setting dimnames
dimnames.ffdf | Getting and setting dimnames of ffdf
dimnames.ff_array | Getting and setting dimnames
dimnames<-.ffdf | Getting and setting dimnames of ffdf
dimnames<-.ff_array | Getting and setting dimnames
dimorder | Getting and setting dim and dimorder
dimorder.default | Getting and setting dim and dimorder
dimorder.ffdf | Getting and setting dim and dimorder
dimorder.ff_array | Getting and setting dim and dimorder
dimorder<- | Getting and setting dim and dimorder
dimorder<-.ffdf | Getting and setting dim and dimorder
dimorder<-.ff_array | Getting and setting dim and dimorder
dimorderCompatible | Test for dimorder compatibility
dimorderStandard | Test for dimorder compatibility
dummy.dimnames | Array: make dimnames

## -- E --

Extract.ff | Reading and writing vectors and arrays (high-level)
Extract.ffdf | Reading and writing data.frames (ffdf)

## -- F --

ff | ff classes for representing (large) atomic data
ffapply | Apply for ff objects
ffcolapply | Apply for ff objects
ffconform | Get most conforming argument
ffdf | ff class for data.frames
ffdfindexget | Reading and writing ffdf data.frame using ff subscripts
ffdfindexset | Reading and writing ffdf data.frame using ff subscripts
ffdforder | Sorting: convenience wrappers for data.frames
ffdfsort | Sorting: convenience wrappers for data.frames
ffdrop | Delete an ffarchive
ffindexget | Reading and writing ff vectors using ff subscripts
ffindexorder | Sorting: chunked ordering of integer suscript positions
ffindexordersize | Sorting: chunked ordering of integer suscript positions
ffindexset | Reading and writing ff vectors using ff subscripts
ffinfo | Inspect content of ff saves
ffload | Reload ffSaved Datasets
fforder | Sorting: order from ff vectors
ffreturn | Return suitable ff object
ffrowapply | Apply for ff objects
ffsave | Save R and ff objects
ffsave.image | Save R and ff objects
ffsort | Sorting of ff vectors
ffsuitable | Test ff object for suitability
ffsuitable_attribs | Test ff object for suitability
ffsymmxtensions | Test for availability of ff extensions
fftempfile | Analyze pathfile-strings
ffvecapply | Apply for ff objects
ffxtensions | Test for availability of ff extensions
ff_pointer | ff classes for representing (large) atomic data
file.move | Change size of move an existing file
file.resize | Change size of move an existing file
filename | Get or set filename
filename.default | Get or set filename
filename.ffdf | Get or set filename
filename.ff_pointer | Get or set filename
filename<- | Get or set filename
filename<-.ff | Get or set filename
finalize | Call finalizer
finalize.ff | Call finalizer
finalize.ffdf | Call finalizer
finalize.ff_pointer | Call finalizer
finalizer | Get and set finalizer (name)
finalizer.ff | Get and set finalizer (name)
finalizer<- | Get and set finalizer (name)
finalizer<-.ff | Get and set finalizer (name)
fixdiag | Test for fixed diagonal
fixdiag.default | Test for fixed diagonal
fixdiag.dist | Test for fixed diagonal
fixdiag.ff | Test for fixed diagonal
fixdiag<- | Test for fixed diagonal

## -- G --

get.ff | Reading and writing vectors of values (low-level)
getalignedpagesize | Get page size information
getdefaultpagesize | Get page size information
geterror.ff | Get error and error string
geterrstr.ff | Get error and error string
getpagesize | Get page size information
getset.ff | Reading and writing vectors of values (low-level)

## -- H --

hi | Hybrid index class
hiparse | Hybrid Index, parsing

## -- I --

is.factor | Getting and setting factor levels
is.factor.default | Getting and setting factor levels
is.factor.ff | Getting and setting factor levels
is.ff | Test for class ff
is.ffdf | Test for class ff
is.open | Test if object is opened
is.open.ff | Test if object is opened
is.open.ffdf | Test if object is opened
is.open.ff_pointer | Test if object is opened
is.ordered | Getting and setting factor levels
is.ordered.default | Getting and setting factor levels
is.ordered.ff | Getting and setting factor levels
is.readonly | Get readonly status
is.readonly.ff | Get readonly status
is.sorted.default | Getting and setting 'is.sorted' physical attribute
is.sorted<-.default | Getting and setting 'is.sorted' physical attribute

## -- K --

keyorder.default | Sorting: order R vector in-RAM and in-place
keysort.default | Sorting: Sort R vector in-RAM and in-place

## -- L --

length.ff | Getting and setting length
length.ffdf | Getting length of a ffdf dataframe
length.hi | Hybrid Index, querying
length<-.ff | Getting and setting length
levels.ff | Getting and setting factor levels
levels<-.ff | Getting and setting factor levels
LimWarn | ff Limitations and Warnings

## -- M --

matcomb | Array: make matrix indices from row and columns positions
matprint | Print beginning and end of big matrix
maxffmode | Lossless vmode coercability
maxindex.hi | Hybrid Index, querying
maxlength | Get physical length of an ff or ram object
maxlength.default | Get physical length of an ff or ram object
maxlength.ff | Get physical length of an ff or ram object
mergeorder.default | Sorting: order R vector in-RAM and in-place
mergesort.default | Sorting: Sort R vector in-RAM and in-place
mismatch | Test for recycle mismatch

## -- N --

na.count.default | Getting and setting 'na.count' physical attribute
na.count.ff | Getting and setting 'na.count' physical attribute
na.count<-.default | Getting and setting 'na.count' physical attribute
na.count<-.ff | Getting and setting 'na.count' physical attribute
names.ff | Getting and setting names
names.ffdf | Getting and setting dimnames of ffdf
names.ff_array | Getting and setting names
names<-.ff | Getting and setting names
names<-.ffdf | Getting and setting dimnames of ffdf
names<-.ff_array | Getting and setting names
ncol<- | Assigning the number of rows or columns
nibble | Create vector of virtual mode
nrow<- | Assigning the number of rows or columns

## -- O --

open.ff | Opening an ff file
open.ffdf | Opening an ff file

## -- P --

pagesize | Pagesize of ff object
pagesize.ff | Pagesize of ff object
pattern | Get or set filename
pattern.ff | Get or set filename
pattern<- | Get or set filename
pattern<-.ff | Get or set filename
pattern<-.ffdf | Get or set filename
physical.ff | Getting and setting physical and virtual attributes of ff objects
physical.ffdf | Getting physical and virtual attributes of ffdf objects
physical<-.ff | Getting and setting physical and virtual attributes of ff objects
poslength.hi | Hybrid Index, querying
print.ff | Print and str methods
print.ffdf | Print and str methods
print.ff_matrix | Print and str methods
print.ff_vector | Print and str methods
print.hi | Hybrid index class
print.matprint | Print beginning and end of big matrix
print.vecprint | Print beginning and end of big vector

## -- Q --

quad | Create vector of virtual mode

## -- R --

radixorder.default | Sorting: order R vector in-RAM and in-place
radixsort.default | Sorting: Sort R vector in-RAM and in-place
ram2ffcode | Factor codings
ram2ramcode | Factor codings
ramattribs | Get ramclass and ramattribs
ramattribs.default | Get ramclass and ramattribs
ramattribs.ff | Get ramclass and ramattribs
ramattribs_excludes | Get ramclass and ramattribs
ramclass | Get ramclass and ramattribs
ramclass.default | Get ramclass and ramattribs
ramclass.ff | Get ramclass and ramattribs
ramclass_excludes | Get ramclass and ramattribs
ramdforder | Sorting: convenience wrappers for data.frames
ramdfsort | Sorting: convenience wrappers for data.frames
ramorder.default | Sorting: order R vector in-RAM and in-place
ramsort.default | Sorting: Sort R vector in-RAM and in-place
read.csv.ffdf | Importing csv files into ff data.frames
read.csv2.ffdf | Importing csv files into ff data.frames
read.delim.ffdf | Importing csv files into ff data.frames
read.delim2.ffdf | Importing csv files into ff data.frames
read.ff | Reading and writing vectors (low-level)
read.table.ffdf | Importing csv files into ff data.frames
readwrite.ff | Reading and writing vectors (low-level)
recodeLevels | Factor level manipulation
recodeLevels.factor | Factor level manipulation
recodeLevels.ff | Factor level manipulation
regtest.fforder | Sorting: regression tests
regtest.vmode | Virtual storage mode
repnam | Replicate with names
row.names.ffdf | Getting and setting dimnames of ffdf
row.names<-.ffdf | Getting and setting dimnames of ffdf

## -- S --

set.ff | Reading and writing vectors of values (low-level)
shellorder.default | Sorting: order R vector in-RAM and in-place
shellsort.default | Sorting: Sort R vector in-RAM and in-place
short | Create vector of virtual mode
sortLevels | Factor level manipulation
sortLevels.factor | Factor level manipulation
sortLevels.ff | Factor level manipulation
sortLevels.ffdf | Factor level manipulation
splitPathFile | Analyze pathfile-strings
standardPathFile | Analyze pathfile-strings
str.ff | Print and str methods
str.ffdf | Print and str methods
str.hi | Hybrid index class
subscript2integer | Hybrid Index, internal utilities
swap | Reading and writing in one operation (high-level)
swap.default | Reading and writing in one operation (high-level)
swap.ff | Reading and writing in one operation (high-level)
swap.ff_array | Reading and writing in one operation (high-level)
symmetric | Test for symmetric structure
symmetric.default | Test for symmetric structure
symmetric.dist | Test for symmetric structure
symmetric.ff | Test for symmetric structure
symmIndex2vectorIndex | Array: make vector positions from symmetric array index

## -- T --

t.ff | Virtual transpose
tempPathFile | Analyze pathfile-strings

## -- U --

ubyte | Create vector of virtual mode
unclass<- | Unclassed assignement
undim | Undim
unsort | Hybrid Index, internal utilities
unsort.ahi | Hybrid Index, internal utilities
unsort.hi | Hybrid Index, internal utilities
unsplitPathFile | Analyze pathfile-strings
update.ff | Update ff content from another object
update.ffdf | Update ff content from another object
ushort | Create vector of virtual mode

## -- V --

vecprint | Print beginning and end of big vector
vector.vmode | Create vector of virtual mode
vector.vmode.default | Create vector of virtual mode
vector.vmode.ff | Create vector of virtual mode
vector2array | Array: make array from vector
vectorCompatible | Test for dimorder compatibility
vectorIndex2arrayIndex | Array: make array from index vector positions
vectorStandard | Test for dimorder compatibility
virtual.ff | Getting and setting physical and virtual attributes of ff objects
virtual.ffdf | Getting physical and virtual attributes of ffdf objects
virtual<-.ff | Getting and setting physical and virtual attributes of ff objects
vmode | Virtual storage mode
vmode.default | Virtual storage mode
vmode.ff | Virtual storage mode
vmode.ffdf | Virtual storage mode of ffdf
vmode<- | Virtual storage mode
vmode<-.default | Virtual storage mode
vmode<-.ff | Virtual storage mode
vt | Virtual transpose
vt.default | Virtual transpose
vt.ff | Virtual transpose
vw | Getting and setting virtual windows
vw.default | Getting and setting virtual windows
vw.ff | Getting and setting virtual windows
vw<- | Getting and setting virtual windows
vw<-.ff_array | Getting and setting virtual windows
vw<-.ff_vector | Getting and setting virtual windows

## -- W --

write.csv | Exporting csv files from ff data.frames
write.csv.ffdf | Exporting csv files from ff data.frames
write.csv2 | Exporting csv files from ff data.frames
write.csv2.ffdf | Exporting csv files from ff data.frames
write.ff | Reading and writing vectors (low-level)
write.table.ffdf | Exporting csv files from ff data.frames

## -- Y --

ymismatch | Test for recycle mismatch

## -- misc --

$.ffdf | Reading and writing data.frames (ffdf)
$<-.ffdf | Reading and writing data.frames (ffdf)
.ffbytes | Virtual storage mode
.ffmode | Virtual storage mode
.rambytes | Virtual storage mode
.rammode | Virtual storage mode
.vcoerceable | Virtual storage mode
.vimplemented | Virtual storage mode
.vmax | Virtual storage mode
.vmin | Virtual storage mode
.vmode | Virtual storage mode
.vNA | Virtual storage mode
.vunsigned | Virtual storage mode
.vvalues | Virtual storage mode
[.ff | Reading and writing vectors and arrays (high-level)
[.ffdf | Reading and writing data.frames (ffdf)
[.ff_array | Reading and writing vectors and arrays (high-level)
[<-.ff | Reading and writing vectors and arrays (high-level)
[<-.ffdf | Reading and writing data.frames (ffdf)
[<-.ff_array | Reading and writing vectors and arrays (high-level)
[[.ff | Reading and writing vectors and arrays (high-level)
[[.ffdf | Reading and writing data.frames (ffdf)
[[<-.ff | Reading and writing vectors and arrays (high-level)
[[<-.ffdf | Reading and writing data.frames (ffdf)