From a852e206f30495a4c89c492cfc9980bb7a02b4cf Mon Sep 17 00:00:00 2001 From: Chris Reudenbach Date: Fri, 10 May 2024 11:55:51 +0200 Subject: [PATCH] typos --- R/initProj.R | 30 +++++++++++++++++------------- docs/pkgdown.yml | 2 +- docs/reference/initProj.html | 19 ++++++++++++++++--- man/initProj.Rd | 30 +++++++++++++++++------------- 4 files changed, 51 insertions(+), 30 deletions(-) diff --git a/R/initProj.R b/R/initProj.R index 4d4447c..59c6afa 100755 --- a/R/initProj.R +++ b/R/initProj.R @@ -109,21 +109,25 @@ createFolders <- function(root_folder, folders, #' @param newsession open project in a new session? default is FALSE #' @param loc_name by default MySite defines the dataset folderlocation and is meant to be a code for the research site #' @param ymlFN filename for a yaml file containing a non standard_setup -#' @note For yaml based setup you need to use one of the default configurations c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this MUST contain at least the standard_setup arguments where \code{ mysetup} is the yaml root\cr -#' \code{mysetup:}\cr -#' \code{dataFolder:}\cr -#' \code{ docsFolder:}\cr -#' \code{ tmpFolder:}\cr -#' \code{ init_git: true/false }\cr -#' \code{ init_renv: true/false }\cr -#' \code{ code_subFolder: ["src", "src/functions" , "src/config"] }\cr -#' \code{ global: false }\cr -#' \code{ libs: }\cr -#' \code{ create_folders: true}\cr -#' \code{ files:}\cr +#' @note For yaml based setup you need to use one of the default configurations +#' c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this +#' MUST contain at least the standard_setup arguments where \code{ mysetup} is the yaml root\cr +#' \preformatted{ +#'mysetup: +#' dataFolder: +#' docsFolder: +#' tmpFolder: +#' init_git: true/false +#' init_renv: true/false +#' code_subFolder: ["src", "src/functions" , "src/config"] +#' global: true/false +#' libs: +#' create_folders: true/false +#' files: +#'} #' Alternatively you may set default_setup to NULL and provide the arguments via command line. #' @details The function uses [setupProj] for setting up the folders. Once the project is creaeted, manage the overall -#' configuration of the project by the src/functions/000_settings.R script. It is sourced at the begining of the +#' configuration of the project by the `src/functions/000_settings.R script`. It is sourced at the begining of the #' template scripts that are created by default. Define additional constans, required libraries etc. in the #' 000_settings.R at any time. If additonal folders are required later, just add them manually. They will be parsed as #' part of the 000_settings.R and added to a variable called dirs that allows easy acces to any of the folders. Use diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index d7dde06..3a83cbe 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -9,7 +9,7 @@ articles: link2GI5: link2GI5.html link2GI6: link2GI6.html link2GI7: link2GI7.html -last_built: 2024-05-10T07:11Z +last_built: 2024-05-10T07:23Z urls: reference: https://r-spatial.github.io/link2GI/reference article: https://r-spatial.github.io/link2GI/articles diff --git a/docs/reference/initProj.html b/docs/reference/initProj.html index 09e185d..6c7ee8b 100644 --- a/docs/reference/initProj.html +++ b/docs/reference/initProj.html @@ -165,7 +165,7 @@

Value

Details

The function uses [setupProj] for setting up the folders. Once the project is creaeted, manage the overall -configuration of the project by the src/functions/000_settings.R script. It is sourced at the begining of the +configuration of the project by the `src/functions/000_settings.R script`. It is sourced at the begining of the template scripts that are created by default. Define additional constans, required libraries etc. in the 000_settings.R at any time. If additonal folders are required later, just add them manually. They will be parsed as part of the 000_settings.R and added to a variable called dirs that allows easy acces to any of the folders. Use @@ -174,8 +174,21 @@

Details

Note

-

For yaml based setup you need to use one of the default configurations c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this MUST contain at least the standard_setup arguments where mysetup is the yaml root
mysetup:
dataFolder:
docsFolder:
tmpFolder:
init_git: true/false
init_renv: true/false
code_subFolder: ["src", "src/functions" , "src/config"]
global: false
libs:
create_folders: true
files:
- Alternatively you may set default_setup to NULL and provide the arguments via command line.

+

For yaml based setup you need to use one of the default configurations +c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this +MUST contain at least the standard_setup arguments where mysetup is the yaml root


+mysetup:
+ dataFolder:  
+ docsFolder:  
+ tmpFolder:   
+ init_git: true/false 
+ init_renv: true/false 
+ code_subFolder: ["src", "src/functions" , "src/config"] 
+ global: true/false 
+ libs: 
+ create_folders: true/false
+ files:
+

Alternatively you may set default_setup to NULL and provide the arguments via command line.

diff --git a/man/initProj.Rd b/man/initProj.Rd index 5b0eebc..a1559d8 100644 --- a/man/initProj.Rd +++ b/man/initProj.Rd @@ -58,7 +58,7 @@ settings templates and git and dvc repository, if necessary. } \details{ The function uses [setupProj] for setting up the folders. Once the project is creaeted, manage the overall -configuration of the project by the src/functions/000_settings.R script. It is sourced at the begining of the +configuration of the project by the `src/functions/000_settings.R script`. It is sourced at the begining of the template scripts that are created by default. Define additional constans, required libraries etc. in the 000_settings.R at any time. If additonal folders are required later, just add them manually. They will be parsed as part of the 000_settings.R and added to a variable called dirs that allows easy acces to any of the folders. Use @@ -66,18 +66,22 @@ this variable to load/save data to avoid any hard coded links in the scripts exc is defined once in the main control script located at src/main.R. } \note{ -For yaml based setup you need to use one of the default configurations c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this MUST contain at least the standard_setup arguments where \code{ mysetup} is the yaml root\cr - \code{mysetup:}\cr - \code{dataFolder:}\cr - \code{ docsFolder:}\cr - \code{ tmpFolder:}\cr - \code{ init_git: true/false }\cr - \code{ init_renv: true/false }\cr - \code{ code_subFolder: ["src", "src/functions" , "src/config"] }\cr - \code{ global: false }\cr - \code{ libs: }\cr - \code{ create_folders: true}\cr - \code{ files:}\cr +For yaml based setup you need to use one of the default configurations +c("base", "baseSpatial","advancedSpatial") or you provide a yaml file this +MUST contain at least the standard_setup arguments where \code{ mysetup} is the yaml root\cr + \preformatted{ +mysetup: + dataFolder: + docsFolder: + tmpFolder: + init_git: true/false + init_renv: true/false + code_subFolder: ["src", "src/functions" , "src/config"] + global: true/false + libs: + create_folders: true/false + files: +} Alternatively you may set default_setup to NULL and provide the arguments via command line. } \examples{