initProj: Defines and creates folders and variables

Description Usage Arguments Examples

View source: R/initProj.R

Description

Defines and creates (if necessary) all folders variables. Returns a list with the project folder pathes. Optionally exports all pathes to a global sub environment.

Usage

1
2
3
4
5
6
7
initProj(
  projRootDir = tempdir(),
  GRASSlocation = "tmp/",
  projFolders = c("data/", "result/", "run/", "log/"),
  path_prefix = "",
  global = FALSE
)

Arguments

projRootDir

project github root directory (your github name)

GRASSlocation

folder for GRASS data

projFolders

list of subfolders in project

path_prefix

character a prefix for the path variables names default is ""

global

boolean esport path strings as global variables default is false

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 

link2GI::initProj(projRootDir = tempdir(),
                 projFolders = c("data/",
                                 "data/level0/",
                                 "data/level1/",
                                  "output/",
                                  "run/",
                                  "fun/") )

## End(Not run)   

link2GI documentation built on Sept. 5, 2021, 5:34 p.m.