linkTo.GenericDataFile: Creates a symbolic file link

linkTo.GenericDataFileR Documentation

Creates a symbolic file link

Description

Creates a symbolic file link to a GenericDataFile at/from a given destination pathname.

Usage

## S3 method for class 'GenericDataFile'
linkTo(this, filename=getFilename(this), path=NULL, skip=!overwrite, overwrite=FALSE,
  ...)

Arguments

filename, path

The filename and the path for the link. The default is to use the same filename as the source file.

skip

If TRUE and a file with the same name as argument link already exists, then the nothing is done.

overwrite

If TRUE, an existing link file is overwritten, otherwise not.

...

Additional arguments passed to createLink.

Value

Returns a GenericDataFile (of the same class as the source file) referring to the file via the link.

Required privileges on Windows

In order for this method to succeed on Windows, the client/R session must run with sufficient privileges. See createLink for more details.

Author(s)

Henrik Bengtsson

See Also

To copy a GenericDataFile, see *copyTo(). Internally createLink is used. For more information see GenericDataFile.


R.filesets documentation built on May 29, 2024, 9:10 a.m.