Update documentation
authorPaul Hoffman <phoffman@nygenome.org>
Tue, 31 Oct 2017 14:59:50 +0000 (10:59 -0400)
committerPaul Hoffman <phoffman@nygenome.org>
Tue, 31 Oct 2017 14:59:50 +0000 (10:59 -0400)
NAMESPACE
R/loom.R
man/connect.Rd
man/loom-class.Rd
man/validateLoom.Rd

index 00c41b3e7479e2fb52f13f895619390a00845a75..393cd11ad40b666764038dfb444000a900c8f711 100644 (file)
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export(connect)
+export(create)
 export(loom)
 export(validateLoom)
 import(hdf5r)
index 8e8f364ccaa433dc068d4573ceb4cabb19b32ce9..93f7804e1275c145e53c358f30ff4adce4d110ad 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -7,8 +7,8 @@ NULL
 #' @docType class
 #' @name loom-class
 #' @rdname loom-class
-#' @return Object of \code{\link{R6Class}} to generate \code{loom} objects
-#' @format An \code{\link{R6Class}} object
+#' @return Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
+#' @format An \code{\link{R6::R6Class}} object
 #' @seealso \code{\link{hdf5r::H5File}}
 #'
 #' @field version Version of loomR object was created under
@@ -239,6 +239,8 @@ loom <- R6Class(
 #'
 #' @seealso \code{\link{loom-class}}
 #'
+#' @export
+#'
 create <- function(
   filename,
   data,
@@ -311,7 +313,9 @@ create <- function(
 #'
 #' @param object A loom object
 #'
-#' @return None, errors if object is an invalid loom connection
+#' @return None, errors out if object is an invalid loom connection
+#'
+#' @seealso \code{\link{loom-class}}
 #'
 #' @export
 #'
@@ -327,7 +331,7 @@ validateLoom <- function(object) {
   }
   # There must be groups called '/col_attrs', '/row_attrs', and '/layers'
   required.groups <- c('row_attrs', 'col_attrs', 'layers')
-  dim.matrix <- object[[root.datasets]]$dims # Rows x Columns
+  dim.matrix <- object[[root.datasets]]$dims # Columns x Rows
   names(x = dim.matrix) <- required.groups[c(2, 1)]
   root.groups <- list.groups(object = object, path = '/', recursive = FALSE)
   group.msg <- paste0(
@@ -371,6 +375,8 @@ validateLoom <- function(object) {
 #'
 #' @return A loom file connection
 #'
+#' @seealso \code{\link{loom-class}}
+#'
 #' @export
 #'
 connect <- function(filename, mode = "r") {
index 0a320062da316c7ae71ae47747a96350bbb801ee..2e50e8ceb390017c3a54bb6e8e953140d88d2393 100644 (file)
@@ -17,3 +17,6 @@ A loom file connection
 \description{
 Connect to a loom file
 }
+\seealso{
+\code{\link{loom-class}}
+}
index ec709fc426b5678022ee8ec02d723c2f52403db2..8e317d88fe5f94c91e753b52e397c9625269ea33 100644 (file)
@@ -5,12 +5,12 @@
 \alias{loom-class}
 \alias{loom}
 \title{A class for loom files}
-\format{An \code{\link{R6Class}} object}
+\format{An \code{\link{R6::R6Class}} object}
 \usage{
 loom
 }
 \value{
-Object of \code{\link{R6Class}} to generate \code{loom} objects
+Object of \code{\link{R6::R6Class}} to generate \code{loom} objects
 }
 \description{
 A class for loom files
index 7002f3f4a9ed9b6fee925c47e0298fb3349b2fdb..8d7ffd424f60da97189dca9c5637589796cdbf32 100644 (file)
@@ -10,8 +10,11 @@ validateLoom(object)
 \item{object}{A loom object}
 }
 \value{
-None, errors if object is an invalid loom connection
+None, errors out if object is an invalid loom connection
 }
 \description{
 Validate a loom object
 }
+\seealso{
+\code{\link{loom-class}}
+}