asDirectoryPath-missing-method: As Directory Path

In rappster/filesystr: Functionality for processing file system ressources

Description

See asDirectoryPath

Usage

## S4 method for signature 'missing'
asDirectoryPath(path = ".", ensure = FALSE,
  strict = FALSE, ...)

Arguments

path	missing.
ensure	logical. Ensure Directory existence (TRUE) or not (FALSE, default).
strict	logical. TRUE: path must exist and be a directory; FALSE: no prior checks. If ensure = TRUE then this is automatically set to FALSE.
...	Further arguments passed to: ensureDirectory.

Value

DirectoryPath.S3. Identical to path with updated class table.

Author(s)

Janko Thyson [e-mail]

References

https://github.com/Rappster/filesystr

See Also

asDirectoryPath-character-method, ensureDirectory

Examples

## Not run: 

##------------------------------------------------------------------------------
## Method: character
##------------------------------------------------------------------------------

## Path //
path_0 <- file.path(tempdir(), "path")

res <- asDirectoryPath(path = path_0)
res
class(res)

## Strict:
try(asDirectoryPath(path = path_0, strict = TRUE))
## --> error as 'path' does not exist yet

path <- tempfile()
file.create(path)
try(asDirectoryPath(path = path, strict = TRUE))
## --> error as 'path' is a file and not a directory 

## Note that 'ensure' overrules 'strict':
asDirectoryPath(path = path_0, ensure = TRUE, strict = TRUE)
file.exists(path_0)

## Clean up //
conditionalDelete(path = path_0, condition = tempdir())

##------------------------------------------------------------------------------
## Method: DirectoryPath.S3
##------------------------------------------------------------------------------

## Path //
path_0 <- file.path(tempdir(), "path2")

res <- asDirectoryPath(path = asDirectoryPath(path_0))
res
class(res)

## Strict:
try(res <- asDirectoryPath(path = asDirectoryPath(path_0), strict = TRUE))
## --> error as 'path' does not exist yet

## Note that 'ensure' overrules 'strict':
asDirectoryPath(path = asDirectoryPath(path_0), ensure = TRUE, strict = TRUE)
file.exists(path_0)

## Clean up //
conditionalDelete(path = path_0, condition = tempdir())


## End(Not run)

rappster/filesystr documentation built on May 26, 2019, 11:17 p.m.