Skip to content
Snippets Groups Projects
zeroPad.Rd 676 B
Newer Older
  • Learn to ignore specific revisions
  • Laura A DeCicco's avatar
    Laura A DeCicco committed
    % Generated by roxygen2 (4.1.1): do not edit by hand
    
    % Please edit documentation in R/zeroPad.r
    
    \name{zeroPad}
    \alias{zeroPad}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \title{Pad string with leading zeros}
    \usage{
    
    zeroPad(x, padTo)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \arguments{
    
    \item{x}{character}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    
    
    \item{padTo}{number Final desired length of the character}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \value{
    
    x character returned with leading zeros
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Function to pad a string with leading zeros. Useful for parameter codes and USGS site IDs.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \examples{
    pCode <- '10'
    
    correctPCode <- zeroPad(pCode,5)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    pCodes <- c('100','1000','0','12345','1565465465465465')
    
    correctPCodes <- zeroPad(pCodes,5)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \keyword{data}
    \keyword{import}
    \keyword{service}
    \keyword{web}