R/clean_path.R

In jstrunk001/RSForInvt: Remote Sensing FORest INVenTory related analysis tasks, especially FUSION, lidR, NVEL

#'@name clean_path
#'@title
#'standardize paths and easy clipboard path updating
#'
#'@description
#'
#'paths often have extra slashes, or in opposing directions. These functions standardize slashes
#'
#'@details
#'
#'standardizes slashes - forward or back
#'
#'  This program is free software but it is provided WITHOUT WARRANTY
#'  and with ABSOLUTELY NO GUARANTEE of fitness or functionality for any purpose;
#'  you can redistribute it and/or modify it under the terms of the GNU
#'  General Public License as published by the Free Software Foundation;
#'  either version 2 of the License, or (at your option) any later version.
#'
#'\cr
#'
#'Revision History
#' \tabular{ll}{
#'1.0 \tab 2015 Jan 29 Roxygen header prepared \cr
#'}
#'
#'
#'@author
#'Jacob Strunk <jstrunk@fs.fed.us>
#'
#'@param path supply a path
#'@param backslash T/F backslashes or forwardslashes?
#'@param force_endslash T/F cap path with slash?
#'
#'@return
#'updated path
#'
#'
#'@examples
#'
#'        clean_path("c:\\temp",F,F)
#'        clean_path("c:\\temp",T,F)
#'        clean_path("c:\\temp",T,T)
#'
#'        clean_path("c:/temp/",F,F)
#'        clean_path("c:\\temp\\\\",T,F)
#'        clean_path("c:\\temp\\\\",T,T)
#'
#'
#'

#'
#'@seealso \code{\link{grep}}\cr \code{\link{gsub}}\cr
#'
#'
#Desired upgrades to this function:
#
#
##main function body
#'@rdname clean_path
#'@export
clean_path=function(
              path
              ,backslash=T
              ,force_endslash=F

             ){

             path_in=unlist(path)

             #fix paths
             #path_ok=gsub("XXXLEADINGXXX","\\\\\\\\",gsub("\\\\\\\\","\\\\",gsub("^\\\\\\\\","XXXLEADINGXXX",gsub("/","\\\\",gsub("\\\\$","",gsub("/$","",path_in))))))
             path_ok=gsub("XXXLEADINGXXX","\\\\\\\\",gsub("\\\\\\\\","\\\\",gsub("^\\\\\\\\","XXXLEADINGXXX",gsub("/","\\\\",gsub("\\\\\\\\$","",gsub("//$","",path_in))))))

             #if slashcap
             if(force_endslash) path_ok=paste(gsub("\\\\$","",path_ok),"\\",sep="")

             #use forward slash
             if(!backslash) path_ok= gsub("\\\\","/",path_ok)

             #return data
             return (path_ok)

             }
#'@rdname clean_path
#'@export
        backslash=function(path) clean_path(path,backslash=T)
#'@rdname clean_path
#'@export
        forwardslash=function(path) clean_path(path,backslash=F)

#'@rdname clean_path
        #'@export
        bs=function(){
          txt = normalizePath(gsub("\"","",readClipboard()),winslash = "\\", mustWork = F)
          writeClipboard("")
          writeClipboard(shQuote(gsub("\\\\","\\\\\\\\",txt)))
          txt
        }
#'@rdname clean_path
        #'@export
        fs=function(){
          txt = normalizePath(gsub("\"","",readClipboard()),winslash = "/",F)
          writeClipboard("")
          writeClipboard(shQuote(txt))
          txt
        }