[Genabel-commits] r1781 - in pkg/DatABEL: . R

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

Author: lckarssen
Date: 2014-07-30 23:13:06 +0200 (Wed, 30 Jul 2014)
New Revision: 1781

Modified:
   pkg/DatABEL/NAMESPACE
   pkg/DatABEL/R/DatABEL-package.R
   pkg/DatABEL/R/apply2dfo_util.R
   pkg/DatABEL/R/databel_class.R
Log:
More work on Roxygenising the DatABEL documentation.

Work in progress...


Modified: pkg/DatABEL/NAMESPACE
===================================================================
--- pkg/DatABEL/NAMESPACE	2014-07-28 13:01:10 UTC (rev 1780)
+++ pkg/DatABEL/NAMESPACE	2014-07-30 21:13:06 UTC (rev 1781)
@@ -1,52 +1,22 @@
-useDynLib(DatABEL)
-
-import(methods)
-
-export(
-	apply2dfo,
-	databel,
-#	databel_filtered_R,
-	make_empty_fvf,
-	databel2text,
-	databel2matrix,
-# BEGIN INTERNAL
-	process_lm_output,
-	matrix2databel,
-# END INTERNAL
-# BEGIN UTIL
-	get_temporary_file_name,
-	extract_text_file_columns,
-	process_lm_output,
-	process_simple_output,
-	sum_NA,
-	sum_not_NA,
-# END UTIL
-	text2databel #,
-#	mytest
-)
-
-exportClasses(
-	"databel"#,
-#	"databel_base_R"
-	)
-
-exportMethods(
-#	"show",
-	"connect",
-	"disconnect",
-	"backingfilename",
-	"cachesizeMb",
-	"cachesizeMb<-",
-	"get_dimnames",
-	"set_dimnames<-",
-#	"as.databel_base_R",
-	"save_as",
-	"setReadOnly<-"
-	)
-
-#S3method(as.vector,databel_base_R)
-#S3method(as.matrix,databel_base_R)
-#S3method(as.matrix,databel_filtered_R)
-#S3method(as.databel_base_R,matrix)
-S3method(as.double,databel)
-
+S3method(as.double,databel)
+export("cachesizeMb<-")
+export("setReadOnly<-")
+export("set_dimnames<-")
+export(apply2dfo)
+export(backingfilename)
+export(cachesizeMb)
+export(connect)
+export(databel)
+export(databel2matrix)
+export(databel2text)
+export(disconnect)
+export(extract_text_file_columns)
+export(get_dimnames)
+export(get_temporary_file_name)
+export(make_empty_fvf)
+export(matrix2databel)
+export(save_as)
+export(text2databel)
+exportClasses(databel)
+exportMethods(show)
+useDynLib(DatABEL)

Modified: pkg/DatABEL/R/DatABEL-package.R
===================================================================
--- pkg/DatABEL/R/DatABEL-package.R	2014-07-28 13:01:10 UTC (rev 1780)
+++ pkg/DatABEL/R/DatABEL-package.R	2014-07-30 21:13:06 UTC (rev 1781)
@@ -19,6 +19,8 @@
 #' @docType package
 #' @name DatABEL-package
 #' @aliases "DatABEL"
+#' @useDynLib DatABEL
+#' @import methods
 #'
 #' @author Yurii Aulchenko (R code), Stepan Yakovenko (R and C++
 #' code), Andrey Chernyh (C++ code)

Modified: pkg/DatABEL/R/apply2dfo_util.R
===================================================================
--- pkg/DatABEL/R/apply2dfo_util.R	2014-07-28 13:01:10 UTC (rev 1780)
+++ pkg/DatABEL/R/apply2dfo_util.R	2014-07-30 21:13:06 UTC (rev 1781)
@@ -86,8 +86,11 @@
     return(out)
 }
 
+#' @export
 process_simple_output <- function(o) return(o)
 
+#' @export
 sum_not_NA <- function(x) return(sum(!is.na(x)))
 
+#' @export
 sum_NA <- function(x) return(sum(is.na(x)))

Modified: pkg/DatABEL/R/databel_class.R
===================================================================
--- pkg/DatABEL/R/databel_class.R	2014-07-28 13:01:10 UTC (rev 1780)
+++ pkg/DatABEL/R/databel_class.R	2014-07-30 21:13:06 UTC (rev 1781)
@@ -16,8 +16,8 @@
 #' @rdname databel-class
 #' @aliases databel-class
 #' @exportClass databel
+#' @import methods
 #' @author Yurii Aulchenko
-#' @useDynLib DatABEL
 #'
 
 #
@@ -551,7 +551,7 @@
     }
     );
 
-
+#' @docType methods
 #' @export
 setGeneric(
     name = "connect",
@@ -588,7 +588,7 @@
     }
     );
 
-
+#' @docType methods
 #' @export
 setGeneric(
     name = "disconnect",