These demonstrate default values for some options that can be set in SpaDES.project. To see defaults, run spadesProjectOptions(). See Details below.

spadesProjectOptions()

Value

named list of the default options currently available.

Details

Below are options that can be set with options("spades.xxx" = newValue), where xxx is one of the values below, and newValue is a new value to give the option. Sometimes these options can be placed in the user's .Rprofile file so they persist between sessions.

The following options are used, and can mostly be specified in the various setup* functions also. The DEFAULT VALUE column lists the value returned by spadesProjectOptions(), which is also the fallback used by setupProject() (and the inner setup* functions) when the option is not otherwise set.

OPTIONDEFAULT VALUEDESCRIPTION
reproducible.cachePath<projectPath>/cacheNOTE: uses reproducible. Within projectPath, with subfolder "cache"
spades.inputPath<projectPath>/inputsWithin projectPath, with subfolder "inputs"
spades.modulePath<projectPath>/modulesWithin projectPath, with subfolder "modules"
spades.outputPath<projectPath>/outputsWithin projectPath, with subfolder "outputs"
spades.packagePath.libPathDefault(<projectPath>)The project-level package library
spades.projectPath"."The project root (current directory by default)
spades.scratchPath<tempdir()>/<projectPath>Within tempdir(), with subfolder basename(projectPath)
SpaDES.project.RestartFALSEPassed to the Restart argument in setupProject
SpaDES.project.useGitFALSEPassed to the useGit argument in setupProject
SpaDES.project.setLinuxBinaryRepoTRUEPassed to the setLinuxBinaryRepo argument in setupProject
SpaDES.project.standAloneTRUEPassed to the standAlone argument in setupProject
SpaDES.project.updateRprofileTRUEPassed to the updateRprofile argument in setupProject
SpaDES.project.overwriteFALSEPassed to the overwrite argument in setupProject
SpaDES.project.askTRUEIf FALSE, do not prompt before cloning a remote GitHub repository
SpaDES.project.gitignoreTRUEWhether setupProject manages a .gitignore for the project
SpaDES.project.fastFALSEIf TRUE, use fastOptions() and skip package/git checks (see setupProject)