Updates to documentation
authorPaul Hoffman <phoffman@nygenome.org>
Fri, 27 Oct 2017 18:23:00 +0000 (14:23 -0400)
committerPaul Hoffman <phoffman@nygenome.org>
Fri, 27 Oct 2017 18:23:00 +0000 (14:23 -0400)
NAMESPACE
R/loom.R
man/connect.Rd [new file with mode: 0644]
man/loom-class.Rd

index 3ec4a35d26f034b2b795727b3b3b6dd2536bc23b..2a2c47da2aa3fe173843abf501f395fa08a4cc07 100644 (file)
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(connect)
 exportClasses(loom)
 import(h5)
 importFrom(methods,callNextMethod)
index c66f118b50723c574b1438b2a4d494da3f71ff3c..edae5a7ad24686bec57f92ef741a45485e0dbb72 100644 (file)
--- a/R/loom.R
+++ b/R/loom.R
@@ -96,14 +96,22 @@ validateLoom <- function(object) {
   }
 }
 
-connect = function(filename, mode = "r+") {
+#' Connect to a loom file
+#'
+#' @param filename The loom file to connect to
+#' @param mode How do we connect to it? Pass 'r' for read-only or 'r+' for read/write
+#'
+#' @return A loom file connection
+#'
+#' @export
+#'
+connect <- function(filename, mode = "r+") {
   self <- new("loom", filename, mode)
   # self@filename <- filename
-  self@shape = dim(self["matrix"])
+  self@shape <- self["matrix"]@dim
   return(self)
 }
 
-
 #need to comment
 #need to add progress bar
 #but otherwise, pretty cool
@@ -113,8 +121,8 @@ connect = function(filename, mode = "r+") {
 # nGene <- map(f, f_list = function(x) length(which(x>0)), MARGIN = 2)
 map <- function(self, f_list = list(mean, var), MARGIN=1, chunksize=1000, selection) {
   n_func = length(f_list)
-  if (n_func==1) f_list=list(f_list)
-  if (MARGIN==1) {
+  if (n_func == 1) f_list=list(f_list)
+  if (MARGIN == 1) {
     results=list();
     for (j in 1:n_func) {
       results[[j]] <- numeric(0)
@@ -131,8 +139,7 @@ map <- function(self, f_list = list(mean, var), MARGIN=1, chunksize=1000, select
       ix <- ix + chunksize
     }
   }
-
-  if (MARGIN==2) {
+  if (MARGIN == 2) {
     results=list();
     for (j in 1:n_func) {
       results[[j]] <- numeric(0)
diff --git a/man/connect.Rd b/man/connect.Rd
new file mode 100644 (file)
index 0000000..c22dec5
--- /dev/null
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/loom.R
+\name{connect}
+\alias{connect}
+\title{Connect to a loom file}
+\usage{
+connect(filename, mode = "r+")
+}
+\arguments{
+\item{filename}{The loom file to connect to}
+
+\item{mode}{How do we connect to it? Pass 'r' for read-only or 'r+' for read/write}
+}
+\value{
+A loom file connection
+}
+\description{
+Connect to a loom file
+}
index a5ca483b55b4f3ad60b6e2d761a6d11127e611d8..4b63d8d7edbcfc53debe3a9956b4c4de3bc21b07 100644 (file)
@@ -11,6 +11,8 @@ A class for loom
 \section{Slots}{
 
 \describe{
-\item{\code{}}{}
+\item{\code{shape}}{The shape of /matrix}
+
+\item{\code{version}}{The version of loomR that this object was made under}
 }}