Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
gisma committed May 10, 2024
1 parent dcb91b3 commit a852e20
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 30 deletions.
30 changes: 17 additions & 13 deletions R/initProj.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 16 additions & 3 deletions docs/reference/initProj.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 17 additions & 13 deletions man/initProj.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a852e20

Please sign in to comment.