initProj: Defines and creates folders and variables

View source: R/initProj.R

initProjR Documentation

Defines and creates folders and variables

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

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

## Not run: 

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

## End(Not run)   

link2GI documentation built on Aug. 29, 2022, 9:06 a.m.