diff --git a/R/parse_qcodes.R b/R/parse_qcodes.R
index e77a698..0a97377 100644
--- a/R/parse_qcodes.R
+++ b/R/parse_qcodes.R
@@ -1,17 +1,41 @@
#' Parse coded text
#'
-#' Take a text document containing coded text of the form:
-#' "stuff to ignore (QCODE) coded text we care about (/QCODE){#qcode} more stuff to ignore"
-#' and turn it into a dataframe with one row per coded item, of the form:
-#' docid,qcode,text
+#' Take a data frame of coded text documents and return a data frame of the
+#' codes captured within.
#'
-#' Replaces newline characters with an HTML "br" in the captured text
-#' returns an empty dataframe (no rows) if no qcodes were found.
+#' This function takes a text document containing coded text of the form:
+#' \preformatted{"stuff to ignore (QCODE) coded text we care about (/QCODE){#my_code}
+#' more stuff to ignore"} and turns it into a data frame with one row per coded
+#' item, of the form: \code{docid,qcode,text}
#'
-#' @param x A data frame containing the text to be coded; requires columns "doc_id" and "document_text"
+#' \code{parse_qcodes} assumes that it is being passed a data frame, the
+#' \code{\link{parse_one_document}} function is called to do the heavy lifting
+#' extracting the coded text from the \code{document_text} column.
+#'
+#' Newline characters are replaced with an HTML \code{
} in the captured text.
+#'
+#' If no valid qcodes are found, \code{parse_qcodes} returns an empty data frame
+#' (no rows).
+#'
+#' @param x A data frame containing the text to be coded; requires columns
+#' "doc_id" and "document_text"
#' @param ... Other parameters optionally passed in
+#' @return If the data frame contains coded text in the \code{document_text}
+#' column, output will be a data frame with three columns: "doc",
+#' "qcode", and "text".
+#'
+#' The "doc" column is the corresponding "doc_id" value from the input
+#' data frame.
+#'
+#' "qcode" is the code that the captured text was marked up with.
+#'
+#' "text" is the text that was captured.
#' @examples
-#' unlink("./_my_qcoder_project", recursive=TRUE)
+#' parse_qcodes(my_documents)
+#'
+#' # Data frames can be piped into this function
+#' my_documents %>%
+#' parse_qcodes()
#' @export
parse_qcodes <- function(x, ...){
diff --git a/man/parse_qcodes.Rd b/man/parse_qcodes.Rd
index 5ff1c7b..3058efe 100644
--- a/man/parse_qcodes.Rd
+++ b/man/parse_qcodes.Rd
@@ -7,20 +7,44 @@
parse_qcodes(x, ...)
}
\arguments{
-\item{x}{A data frame containing the text to be coded; requires columns "doc_id" and "document_text"}
+\item{x}{A data frame containing the text to be coded; requires columns
+"doc_id" and "document_text"}
\item{...}{Other parameters optionally passed in}
}
+\value{
+If the data frame contains coded text in the \code{document_text}
+column, output will be a data frame with three columns: "doc",
+"qcode", and "text".\preformatted{ The \code{doc} is the \code{doc_id} from the input data frame.
+
+ \code{qcode} is the code that the captured text was marked up with.
+
+ \code{text} is the text that was captured.
+}
+}
\description{
-Take a text document containing coded text of the form:
-"stuff to ignore (QCODE) coded text we care about (/QCODE){#qcode} more stuff to ignore"
-and turn it into a dataframe with one row per coded item, of the form:
-docid,qcode,text
+Take a data frame of coded text documents and return a data frame of the
+codes captured within.
}
\details{
-Replaces newline characters with an HTML "br" in the captured text
-returns an empty dataframe (no rows) if no qcodes were found.
+This function takes a text document containing coded text of the form:
+\preformatted{"stuff to ignore (QCODE) coded text we care about (/QCODE){#my_code}
+more stuff to ignore"} and turns it into a data frame with one row per coded
+item, of the form: \code{docid,qcode,text}
+
+\code{parse_qcodes} assumes that it is being passed a data frame, the
+\code{\link{parse_one_document}} function is called to do the heavy lifting
+extracting the coded text from the \code{document_text} column.
+
+Newline characters are replaced with an HTML \code{
} in the captured text.
+
+If no valid qcodes are found, \code{parse_qcodes} returns an empty data frame
+(no rows).
}
\examples{
-unlink("./_my_qcoder_project", recursive=TRUE)
+parse_qcodes(my_documents)
+
+# Data frames can be piped into this function
+my_documents \%>\%
+ parse_qcodes()
}
diff --git a/man/qcode.Rd b/man/qcode.Rd
index f1c0feb..570cf5e 100644
--- a/man/qcode.Rd
+++ b/man/qcode.Rd
@@ -4,7 +4,7 @@
\alias{qcode}
\title{This launches the coder Shiny app}
\usage{
-qcode(use_wd = FALSE)
+qcode(use_wd = TRUE)
}
\arguments{
\item{use_wd}{Whether or not the current working directory when launching