Verified Commit 8aa586ed authored by Cody L Marquart's avatar Cody L Marquart
Browse files

docs and tests

parent 46b927ef
Pipeline #45809 failed with stages
in 4 minutes and 31 seconds
......@@ -3,4 +3,5 @@
^cran-comments\.md$
demo/app/
demo/backup/
^.gitlab-ci.yml
\ No newline at end of file
^.gitlab-ci.yml
docs/
\ No newline at end of file
......@@ -38,6 +38,7 @@ getHandSetIndices = function(codeToUse, handSetLength = 20, handSetBaserate = 0.
#' @param handSetLength Number of excerpts to put into the test set
#' @param handSetBaserate Minimum number of positives that should be in the test set
#' @param unseen [TBD]
#' @param this.set [TBD]
#'
#' @return Code object with an updated test set and computer set
#' @export
......
......@@ -8,7 +8,9 @@
#' @param n Number of excerpts to handcode
#' @param baserate Value between 0 and 1, inflates the baserate chosen excerpts to code, ensuring the number of positive at least equal to n * baserate
#' @param unseen Logical or number Indicating additional excerpts with unseen words should be added. If TRUE (default), two words added or by `number`
#'
#' @param this.set [TBD]
#' @param results [TBD]
#'
#' @import cli
#' @export
#' @return Code
......
......@@ -77,7 +77,7 @@ print.summary.CodeSet = function(x, ...){
#' newcode = create.code(name = "Data",
#' expressions = c("number","data"), excerpts = rs$text)
#' #newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
#' newcode = test(code = newcode, kappaThreshold = 0.65)
#' newcode = test(code = newcode, kappa_threshold = 0.65)
#' summary(newcode$statistics)
#' @return list of Test summary
#' @export
......@@ -109,7 +109,7 @@ summary.TestList = function(object, ...) {
#' newcode = create.code( name = "Data",
#' expressions = c("number","data"), excerpts = rs$text)
#' #newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
#' newcode = test(code = newcode, kappaThreshold = 0.65)
#' newcode = test(code = newcode, kappa_threshold = 0.65)
#' summary(newcode$statistics)
#' @return prints summary
#' @export
......@@ -128,7 +128,7 @@ print.summary.TestList = function(x, ...) {
#' newcode = create.code(name = "Data",
#' expressions = c("number","data"), excerpts = rs$text)
#' #newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
#' newcode = test(code = newcode, kappaThreshold = 0.65)
#' newcode = test(code = newcode, kappa_threshold = 0.65)
#' summary(newcode$statistics)
#' @return list of Test summary
#' @export
......@@ -164,7 +164,7 @@ summary.Test = function(object, ...) {
#' newcode = create.code( name = "Data",
#' expressions = c("number","data"), excerpts = rs$text)
#' #newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
#' newcode = test(code = newcode, kappaThreshold = 0.65)
#' newcode = test(code = newcode, kappa_threshold = 0.65)
#' summary(newcode$statistics)
#' @return prints summary
#' @export
......
......@@ -15,6 +15,8 @@ getHandSetIndices2(code, handSetLength = 20, handSetBaserate = 0.2,
\item{handSetBaserate}{Minimum number of positives that should be in the test set}
\item{unseen}{[TBD]}
\item{this.set}{[TBD]}
}
\value{
Code object with an updated test set and computer set
......
......@@ -20,6 +20,10 @@ handcode(code = NULL, excerpts = NULL, expressions = NULL,
\item{baserate}{Value between 0 and 1, inflates the baserate chosen excerpts to code, ensuring the number of positive at least equal to n * baserate}
\item{unseen}{Logical or number Indicating additional excerpts with unseen words should be added. If TRUE (default), two words added or by `number`}
\item{this.set}{[TBD]}
\item{results}{[TBD]}
}
\value{
Code
......
......@@ -23,6 +23,6 @@ rs = RS.data
newcode = create.code( name = "Data",
expressions = c("number","data"), excerpts = rs$text)
#newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
newcode = test(code = newcode, kappaThreshold = 0.65)
newcode = test(code = newcode, kappa_threshold = 0.65)
summary(newcode$statistics)
}
......@@ -23,6 +23,6 @@ rs = RS.data
newcode = create.code( name = "Data",
expressions = c("number","data"), excerpts = rs$text)
#newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
newcode = test(code = newcode, kappaThreshold = 0.65)
newcode = test(code = newcode, kappa_threshold = 0.65)
summary(newcode$statistics)
}
......@@ -23,6 +23,6 @@ rs = RS.data
newcode = create.code(name = "Data",
expressions = c("number","data"), excerpts = rs$text)
#newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
newcode = test(code = newcode, kappaThreshold = 0.65)
newcode = test(code = newcode, kappa_threshold = 0.65)
summary(newcode$statistics)
}
......@@ -23,6 +23,6 @@ rs = RS.data
newcode = create.code(name = "Data",
expressions = c("number","data"), excerpts = rs$text)
#newcode = handcode(code = newcode, excerpts = rs$text, n = 4)
newcode = test(code = newcode, kappaThreshold = 0.65)
newcode = test(code = newcode, kappa_threshold = 0.65)
summary(newcode$statistics)
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment