export mrcs

BushmanLab · Aug 21, 2015 · abaa544 · abaa544
1 parent 28a3f10
commit abaa544
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,6 +1,7 @@
 # Generated by roxygen2 (4.1.1): do not edit by hand
 
 export(create_connection_from_files)
+export(getMRCs)
 export(getMultihitLengths)
 export(getUniquePCRbreaks)
 export(getUniqueSiteCounts)

diff --git a/R/intSiteRetriever.R b/R/intSiteRetriever.R
@@ -141,6 +141,7 @@ getUniqueSiteCounts <- function(sample_ref, conn) {
 #' @param numberOfMRCs how many controls for each site
 #' @param connection: DB or File connection
 #' @return df with cols: siteID, position, strand, chr, sampleName, refGenome
+#' @export
 #'
 getMRCs <- function(sample_ref, conn, numberOfMRCs=3) {
     if (is.list(conn) && "sitesFromFiles" %in% names(conn) && conn$sitesFromFiles == TRUE) {

diff --git a/man/getMRCs.Rd b/man/getMRCs.Rd
@@ -4,14 +4,17 @@
 \alias{getMRCs}
 \title{creates match random controls.}
 \usage{
-getMRCs(setName, numberOfMRCs = 3, conn = NULL)
+getMRCs(sample_ref, conn, numberOfMRCs = 3)
 }
 \arguments{
-\item{setName}{vector of sample names}
-
 \item{numberOfMRCs}{how many controls for each site}
 
-\item{conn}{connection: DB or File connection}
+\item{sampe_ref}{df with 2 cols: sampleName, refGenome}
+
+\item{connection:}{DB or File connection}
+}
+\value{
+df with cols: siteID, position, strand, chr, sampleName, refGenome
 }
 \description{
 creates match random controls.