createProfile: Define user profile information

Description Usage Arguments Examples

View source: R/profile.yaml.R

Description

This creates a file that describes where necessary executables are located in order to run make. This sets up a template, it is necessary to fill in the missing information

Usage

1
createProfile(directory = "~/.vizlab", overwrite = FALSE)

Arguments

directory

location to save the profile.yaml file. Though directory accepts any directory path, the only useful values are those that point to ~/.vizlab or code./vizlab at runtime. The default is recommended except when the system variable HOME differs between the current R session (try Sys.getenv('HOME')) and the bash session from which make will be run (open bash and try echo $HOME). This parameter should match the bash version at a minimum; it might also be useful to run createProfile() once for each possible value of HOME (see examples). Another option is "./vizlab" within the project directory for this particular visualization.

overwrite

logical. If the file exists, should it be overwritten?

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
# The two calls commonly useful for Windows:
createProfile()
createProfile("~/../.vizlab")

# Example file for Windows user[s]:
SHELL: c:/Rtools/bin/sh.exe
R: C:/Program Files/R/R-3.3.2/bin/x64/R.exe
RSCRIPT: C:/Program Files/R/R-3.3.2/bin/x64/Rscript.exe
R_LIBS_USER: C:/Users/aappling/Documents/R/win-library/3.3

## End(Not run)

USGS-VIZLAB/vizlab documentation built on Oct. 31, 2018, 5:35 p.m.