[R-gregmisc-commits] r2037 - pkg/gtools/man

[noreply at r-forge.r-project.org]

Author: warnes
Date: 2015-05-27 02:21:04 +0200 (Wed, 27 May 2015)
New Revision: 2037

Added:
   pkg/gtools/man/asc.Rd
Log:
Add asc() and chr() functions for converting between characters and ASCII codes

Added: pkg/gtools/man/asc.Rd
===================================================================
--- pkg/gtools/man/asc.Rd	                        (rev 0)
+++ pkg/gtools/man/asc.Rd	2015-05-27 00:21:04 UTC (rev 2037)
@@ -0,0 +1,67 @@
+\name{asc}
+\alias{asc}
+\alias{chr}
+\title{Convert between characters and ASCII codes}
+\description{
+  \code{asc} returns the ASCII codes for the specified characters.
+  \code{chr} returns the characters corresponding to the specified ASCII codes.
+}
+\usage{
+  asc(char, simplify=TRUE)
+  chr(ascii)
+}
+\arguments{
+  \item{char}{vector of character strings}
+
+  \item{simplify}{logical indicating whether to attempt to convert the
+    result into a vector or matrix object. See \code{\link[base]{sapply}}
+    for details.
+  }
+  \item{ascii}{vector or list of vectors containing integer ASCII codes}
+}
+\value{
+  \code{asc} returns the integer ASCII values for each character
+  in the elements of \code{char}.  If \code{simplify=FALSE} the result
+  will be a list contining one vector per element of \code{char}.  If
+  \code{simplify=TRUE}, the code will attempt to convert the result into
+  a vector or matrix.
+
+  \code{asc} returns the characters corresponding to the provided ASCII
+  values.
+}
+\author{
+  Adapted by Gregory R. Warnes \email{greg at warnes.net} from code posted
+  on the 'Data Debrief' blog on 2011-03-09 at
+  \url{http://datadebrief.blogspot.com/2011/03/ascii-code-table-in-r.html}.
+}
+\seealso{
+  \code{\link[base]{strtoi}},
+  \code{\link[base]{charToRaw}},
+  \code{\link[base]{rawToChar}},
+  \code{\link[base]{as.raw}}
+}
+\examples{
+  ## ascii codes for lowercase letters
+  asc(letters)
+
+  ## uppercase letters from ascii codes
+  chr(65:90)
+
+  ## works on muti-character strings
+  ( tmp <- asc('hello!') )
+  chr(tmp)
+
+  ## Use 'simplify=FALSE' to return the result as a list
+  ( tmp <- asc('hello!', simplify=FALSE) )
+  chr(tmp)
+
+  ## When simplify=FALSE the results can be...
+  asc( c('a', 'e', 'i', 'o', 'u', 'y' ) ) # a vector
+  asc( c('ae', 'io', 'uy' ) )             # or a matrix
+
+  ## When simplify=TRUE the results are always a list...
+  asc( c('a', 'e', 'i', 'o', 'u', 'y' ), simplify=FALSE )
+  asc( c('ae', 'io', 'uy' ), simplify=FALSE)
+}
+\keyword{character}
+\keyword{programming}