[R-gregmisc-users] SF.net SVN: r-gregmisc: [1134] trunk/SASxport

[<wa...@us...>]

Revision: 1134
          http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1134&view=rev
Author:   warnes
Date:     2007-08-10 17:03:52 -0700 (Fri, 10 Aug 2007)

Log Message:
-----------
Improve package description

Modified Paths:
--------------
    trunk/SASxport/DESCRIPTION
    trunk/SASxport/man/SASxport-package.Rd

Modified: trunk/SASxport/DESCRIPTION
===================================================================
--- trunk/SASxport/DESCRIPTION	2007-08-09 23:29:01 UTC (rev 1133)
+++ trunk/SASxport/DESCRIPTION	2007-08-11 00:03:52 UTC (rev 1134)
@@ -6,14 +6,21 @@
 Author: Gregory R. Warnes <gr...@ra...>,
         includes code from Frank E. Harrell, Jr.'s Hmisc package.   
 Maintainer: Gregory R. Warnes <gr...@ra...>
-Description: This package provides functions to read, list contents of, and  
-             write SAS export files.  This package was created by Random 
-             Technologies LLC <http://random-technologies-llc.com> with funding
-             by Metrum Institute <http://metruminstitute.org>. 
+Description: This package provides functions for both reading, listing
+	     contents of, and writing SAS xport format files. Reading
+	     and writing of both individual and sets of data frames
+	     are supported.   Further, a mechanism has been provided
+	     for customizing how variables of different data types are
+	     stored.
+	     .
+	     This package was created by Random Technologies LLC
+	     <http://random-technologies-llc.com> with funding by
+	     Metrum Institute <http://metruminstitute.org>.  
              .
              Technical support contracts and other services for for R, this 
              package, and other packages are available from Random Technologies
              LLC <http://random-technologies-llc.com>.
+
 License: GPL 2.0 or later
 Imports: methods, foreign, chron
 

Modified: trunk/SASxport/man/SASxport-package.Rd
===================================================================
--- trunk/SASxport/man/SASxport-package.Rd	2007-08-09 23:29:01 UTC (rev 1133)
+++ trunk/SASxport/man/SASxport-package.Rd	2007-08-11 00:03:52 UTC (rev 1134)
@@ -3,39 +3,67 @@
 \alias{SASxport}
 \docType{package}
 \title{
-Read and write SAS export files
+  Read and write SAS export files
 }
 \description{
-This package provides functions to read, list contents of,
-and write SAS export files.
+  This package provides functions to read, list contents of, and write
+  SAS export files.
 }
 \details{
 
-This package was created by Random
-Technologies LLC <http://random-technologies-llc.com> with funding by
-Metrum Institute <http://metruminstitute.org>.
+  The read.xport function for reading xport files augments the
+  functionality of the read.xport function provided in the "recommended" 
+  package 'foreign' with additional features borrowed from Frank Harrell's
+  sasxport.get() in the 'Hmisc' package.  Namely, variables are properly
+  coerced into the types specified by the format field. All standard
+  numeric and string formats are supported  automatically, while
+  user-defined formats are supported when the used has included the format
+  data in the xport file via
+
+     PROC FORMAT CNTLOUT=format;
+
+  The write.xport function writes one or more data sets into a SAS xport
+  file.  Standard R data types, including date and time objects
+  (e.g. Date, and POSIX.t) are stored with proper SAS format types.
+  Handling of object formatting is customizable by providing methods for
+  the function toSAS().  This is accomplished by writing a new method
+  for toSAS() for the object class of interest. The toSAS() method is
+  responsible for converting its argument to either a simple floating
+  point or character variable (the only basic types permitted by the
+  xport format) and adding the appropriate SAS format code in the
+  'format' attribute. 
+
+  The write.xport() function, further, allows the user to override the
+  operating system type and SAS version information, as well as object
+  creation and modification times.
+
   
-Index:
+  This package was created by Random Technologies LLC
+  <http://random-technologies-llc.com> with funding by Metrum Institute
+  <http://metruminstitute.org>. 
+
+}
+\section{Index}{
 \preformatted{
 lookup.xport            Lookup Information on a SAS XPORT Format
                         Library
 read.xport              Import SAS XPORT files
-toSAS.default           Convert R data object for storage in SAS xport
-                        file
-units                   Set or Retreive the label, format, iformat, or
-                        units Attribute of a Vector
+toSAS.default           Convert R data object for storage in SAS 
+                        xport file
+units                   Set or Retreive the label, format, 
+                        iformat, or units Attribute of a Vector
 write.xport             Write data to a SAS XPORT file
 }
 }
 \author{
-Gregory R. Warnes <gr...@ra...>, includes
-code from Frank E. Harrell, Jr.'s Hmisc package.
+  Gregory R. Warnes <gr...@ra...>, includes
+  code from Frank E. Harrell, Jr.'s Hmisc package.
 
-Maintainer: Gregory R. Warnes <gr...@ra...>
+  Maintainer: Gregory R. Warnes <gr...@ra...>
 }
-\section{support}{
-Technical support contracts and other services for for R, this package,
-and other packages are available from Random Technologies LLC
-<http://random-technologies-llc.com>.
+\section{Support}{
+  Technical support contracts and other services for for R, this package,
+  and other packages are available from Random Technologies LLC
+  <http://random-technologies-llc.com>.
 }
 \keyword{ package }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.