unpackExampleData: Copy package data to a new folder

Description Usage Arguments Details Value Examples

View source: R/unpackExampleData.R

Description

The SSNdesign package contains several .ssn and .Rdata files. These are the files referred to in the package vignette. This function takes these files out of SSNdesign's folders and copies them to a user-specified location on the user's computer.

Usage

1
unpackExampleData(unpack.loc)

Arguments

unpack.loc

The path to some folder on the user's computer that the files should be copied to.

Details

Please note that the function will return FALSE, indicating unsuccessful file transfer, if the directory specified in unpack.loc already contains files with the same names as the example data files.

Value

A logical indicating whether file transfer was successful.

Examples

1
2
3
4
5
6
## Not run: 

# To the documents folder:
unpackExampleData("~/")

## End(Not run)

apear9/SSNdesign documentation built on Feb. 19, 2020, 4:29 a.m.