Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
gisma committed May 31, 2024
1 parent 793b574 commit 8c6e5de
Show file tree
Hide file tree
Showing 36 changed files with 108 additions and 108 deletions.
26 changes: 13 additions & 13 deletions R/grassControl.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#'@title Usually for internally usage, get 'GRASS GIS' and \code{rgrass} parameters on 'Linux' OS
#'@name paramGRASSx
#'@description Initialize and set up \code{rgrass} for 'Linux'
#'@details During the rsession you will have full access to GRASS7 GIS via the \code{rgrass} wrapper. Additionally you may use also use the API calls of GRASS7 via the command line.
#'@param set_default_GRASS default = NULL will force a search for 'GRASS GIS' You may provide a valid combination as
#'@details During the rsession you will have full access to GRASS7 GIS via the \code{rgrass} wrapper. Additionally you may use also use the API calls of GRASS via the command line.
#'@param set_default_GRASS, default is NULL. will force a search for 'GRASS GIS' You may provide a valid combination as
#' c("/usr/lib/grass74","7.4.1","grass74")
#'@param MP mount point to be searched. default is "/usr/bin"
#'@param quiet Boolean switch for suppressing console messages default is TRUE
#'@param MP, default is "/usr/bin". mount point to be searched.
#'@param quiet boolean, default is TRUE. switch for suppressing console messages
#'@param ver_select if TRUE you must interactively select between alternative installations
#'@keywords internal
#'
Expand Down Expand Up @@ -96,7 +96,7 @@ paramGRASSx <- function(set_default_GRASS=NULL,
#'@details The concept is very straightforward but for an all days usage pretty
#' helpful. You need to provide a \code{terra} or a \code{sf} object. The derived properties are used to initialize a temporary but static
#' \href{https://CRAN.R-project.org/package=rgrass}{rgrass} environment. During the rsession you will have full access to
#' GRASS7 both via the wrapper package as well as the command line. paramGRASSw initializes the usage of GRASS7.
#' GRASS7 both via the wrapper package as well as the command line. paramGRASSw initializes the usage of GRASS.
#'@param DL character search location default = \code{C:}
#'@param ver_select boolean default is FALSE. If there is more than one 'SAGA GIS' installation and \code{ver_select} = TRUE the user can select interactively the preferred 'SAGA GIS' version
#'@param set_default_GRASS default = NULL forces a full search for 'GRASS GIS' binaries. You may
Expand Down Expand Up @@ -357,8 +357,8 @@ searchGRASSW <- function(DL = "C:/",
#'@description Searches recursively for valid 'GRASS GIS' installations at a given 'Linux' mount point.
#'Returns attributes for each installation.
#'@param MP default is /usr. This is the directory from which the grass executable file is searched, i.e. one executable for each GRASS installation on the system.
#'@return A dataframe containing 'GRASS GIS' binary folder(s) (i.e. where the individual GRASS commands are installed), version name(s) and installation type code(s)
#'@param quiet boolean switch for supressing console messages default is TRUEs
#'@return data frame containing 'GRASS GIS' binary folder(s) (i.e. where the individual GRASS commands are installed), version name(s) and installation type code(s)
#'@param quiet boolean. switch for suppressing console messages default is TRUE

#'@author Chris Reudenbach
#'@export searchGRASSX
Expand Down Expand Up @@ -435,15 +435,15 @@ searchGRASSX <- function(MP = "/usr/bin",quiet =TRUE){
#'@description Initializes and set up access to 'GRASS GIS 7.xx' via the \code{rgrass} wrapper or command line packages. Set and returns all necessary environment variables and additionally returns the GISBASE directory as string.
#'@param root_GRASS grass root directory i.e. "C:\\OSGEO4~1",
#'@param grass_version grass version name i.e. "grass-7.0.5"
#'@param installation_type two options "osgeo4w" as installed by the 'OSGeo4W'-installer and "NSIS" that is typical for a stand_alone installtion of 'GRASS GIS'.
#'@param quiet boolean switch for supressing console messages default is TRUE
#'@param installation_type two options "osgeo4w" as installed by the 'OSGeo4W'-installer and "NSIS" that is typical for a stand_alone installation of 'GRASS GIS'.
#'@param quiet boolean switch for suppressing console messages default is TRUE
#'@param jpgmem jpeg2000 memory allocation size. Default is 1000000
#'@author Chris Reudenbach
#'@keywords internal
#'
#'@examples
#' \dontrun{
#' # set choosen'GRASS GIS' installation folders
#' # set selected 'GRASS GIS' installation folders
#' setenvGRASSw(root_GRASS = "C:\\PROGRA~1\\QGIS2~1.18",
#' grass_version = "grass-7.2.1",
#' installation_type = "osgeo4W")
Expand Down Expand Up @@ -561,9 +561,9 @@ checkGisdbase <- function(x = NULL , gisdbase = NULL, location = NULL, gisdbase_
#'@param searchLocation Location to search for the grass executable, i.e. one executable for each GRASS installation on the system. For Windows systems it is mandatory to include an uppercase Windows drive letter and a colon.
#'Default for Windows systems
#'is \code{C:/}, for Linux systems the default is \code{/usr/bin}.
#'@param ver_select boolean Default is FALSE. If there is more than one 'GRASS GIS' installation and \code{ver_select} = TRUE, the user can interactively select the preferred 'GRASS GIS' version.
#'@param quiet boolean switch to suppress console messages, default is TRUE
#'@return A dataframe with the 'GRASS GIS' binary folder(s) (i.e. where the individual
#'@param ver_select boolean, Default is FALSE. If there is more than one 'GRASS GIS' installation and \code{ver_select} = TRUE, the user can interactively select the preferred 'GRASS GIS' version.
#'@param quiet boolean, default is TRUE. switch to suppress console messages
#'@return data frame with the 'GRASS GIS' binary folder(s) (i.e. where the individual
#'individual GRASS commands are installed), version name(s) and
#'installation type code(s)
#'@author Chris Reudenbach
Expand Down
2 changes: 1 addition & 1 deletion R/linkGDAL.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ if (!isGeneric('linkGDAL')) {
#'@param ver_select Boolean default is FALSE. If there is more than one 'GDAL' installation and \code{ver_select} = TRUE the user can select interactively the preferred 'GDAL' version
#'@param searchLocation string hard drive letter default is \code{C:/}
#'@param quiet Boolean switch for suppressing messages default is TRUE
#'@param returnPaths Boolean if set to FALSE the pathes of the selected version are written
#'@param returnPaths Boolean if set to FALSE the paths of the selected version are written
#' to the PATH variable only, otherwise all paths and versions of the installed GRASS versions ae returned.

#'
Expand Down
4 changes: 2 additions & 2 deletions R/linkGRASS.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ if (!isGeneric('linkGRASS')) {
#' \href{https://CRAN.R-project.org/package=rgrass}{rgrass} environment with the correct 'GRASS' structure.\cr\cr
#' The most time consuming part on Windows systems is the search process. This can easily take 10 minutes or more.
#' To speed up this process, you can also provide a correct parameter set. The best way to do this is to manually call \code{searchGRASSW} or for 'Linux' \code{searchGRASSX}.
#' and call \code{linkGRASS} with the version arguments of your choice. linkGRASS will initialize the use of GRASS7.
#' If you have more than one valid installation and call \code{linkGRASS()} without arguments, you will be asked to choose one.
#' and call \code{linkGRASS} with the version arguments of your choice. linkGRASS will initialize the use of GRASS.
#' If you have more than one valid installation and call \code{linkGRASS()} without arguments, you will be asked to select one.
#'@param search_path Path or mount point to search for.
#'@param x raster/terra or sf/sp object
#'@param default_GRASS default is \code{NULL} If is \code{NULL} an automatic search for all installed versions is performed.
Expand Down
6 changes: 3 additions & 3 deletions R/linkOTB.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ if (!isGeneric('linkOTB')) {
#'@details It looks for the \code{otb_cli.bat} file. If the file is found in a \code{bin} folder it is assumed to be a valid 'OTB' binary installation.
#'@param bin_OTB string contains path to where the otb binaries are located
#'@param root_OTB string provides the root folder of the \code{bin_OTB}
#'@param ver_select Boolean default is FALSE. If there is more than one 'OTB' installation and \code{ver_select} = TRUE the user can select interactively the preferred 'OTB' version In opposite if FALSE the newest version is automatically choosen.
#'@param ver_select Boolean, default is FALSE. If there is more than one 'OTB' installation and \code{ver_select} = TRUE the user can interactively select the preferred 'OTB' version, conversely if FALSE the latest version is automatically selected.
#'@param searchLocation string hard drive letter (Windows) or mounting point (Linux) default for Windows is \code{C:}, default for Linux is \code{~}
#'@param type_OTB string
#'@param quiet Boolean switch for suppressing messages default is TRUE
#'@param returnPaths Boolean if set to FALSE the pathes of the selected version are written
#' to the PATH variable only, otherwise all paths and versions of the installed GRASS versions ae returned.
#'@param returnPaths Boolean, if set to FALSE the paths of the selected version are written.
#' in the PATH variable only, otherwise all paths and versions of the installed OTB versions are returned.

#'
#'@note You may also set the path manually. Using a 'OSGeo4W64' \url{https://trac.osgeo.org/osgeo4w/} installation it is typically \code{C:/OSGeo4W64/bin/}
Expand Down
2 changes: 1 addition & 1 deletion R/parseOTB.R
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ parseOTBFunction <- function(algo=NULL,gili=NULL) {
#'@param quiet boolean if TRUE suppressing messages default is TRUE
#'@param retRaster boolean if TRUE a raster stack is returned default is FALSE
#'@param retCommand boolean if TRUE only the OTB API command is returned default is FALSE
#'@details #' Please NOTE: You must check the help to identify the correct input file argument codewort ($input_in or $input_il).
#'@details #' Please NOTE: You must check the help to identify the correct input file argument ($input_in or $input_il).
#'@examples
#'\dontrun{
#' require(link2GI)
Expand Down
14 changes: 7 additions & 7 deletions R/sagaControl.R
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ searchSAGAX <- function(MP = "/usr/bin",

#'@title Searches recursively for existing 'Windows' 'SAGA GIS' installation(s)
#'@name searchSAGAW
#'@description Searches recursivley for existing 'SAGA GIS' installation(s) on a given 'Windows' drive
#'@description Searches recursively for existing 'SAGA GIS' installation(s) on a given 'Windows' drive
#'@param DL drive letter default is \code{C:/}
#'@param quiet boolean switch for supressing messages default is TRUE
#'@return A dataframe contasining the 'SAGA GIS' root folder(s), the version name(s) and the installation type(s)
#'@param quiet boolean switch for suppressing messages default is TRUE
#'@return A data frame containing the 'SAGA GIS' root folder(s), the version name(s) and the installation type(s)
#'@author Chris Reudenbach
#'@keywords internal
#'@export searchSAGAW
Expand Down Expand Up @@ -200,15 +200,15 @@ searchSAGAX <- function(MP = "/usr/bin",
return(sagaPath)
}

#'@title Search recursivly existing 'SAGA GIS' installation(s) at a given drive/mountpoint
#'@title Search recursively existing 'SAGA GIS' installation(s) at a given drive/mount point
#'@name findSAGA
#'@description Provides an list of valid 'SAGA GIS' installation(s)
#'on your 'Windows' system. There is a major difference between osgeo4W and
#'stand_alone installations. The functions trys to find all valid
#'installations by analysing the calling batch scripts.
#'stand_alone installations. The functions tries to find all valid
#'installations by analyzing the calling batch scripts.
#'@param searchLocation drive letter to be searched, for Windows systems default
#' is \code{C:/}, for Linux systems default is \code{/usr/bin}.
#'@param quiet boolean switch for supressing console messages default is TRUE
#'@param quiet boolean switch for suppressing console messages default is TRUE

#'@return A dataframe with the 'SAGA GIS' root folder(s), version name(s) and
#'installation type code(s)
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/link2GI2.html

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

4 changes: 2 additions & 2 deletions docs/articles/link2GI3.html

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

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-31T15:58Z
last_built: 2024-05-31T20:21Z
urls:
reference: https://r-spatial.github.io/link2GI/reference
article: https://r-spatial.github.io/link2GI/articles
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/findGRASS.html

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

Loading

0 comments on commit 8c6e5de

Please sign in to comment.