diff --git a/DESCRIPTION b/DESCRIPTION index ece643e..ef33982 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,7 +28,6 @@ Imports: methods, openxlsx, rlang, - stringi, tinytex Suggests: arrow, @@ -36,7 +35,8 @@ Suggests: knitr, mockery, rmarkdown, + stringi, testthat (>= 2.1.0) -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.1 VignetteBuilder: knitr Encoding: UTF-8 diff --git a/man/codeBookItemBody.Rd b/man/codeBookItemBody.Rd index abe9f12..74eae62 100644 --- a/man/codeBookItemBody.Rd +++ b/man/codeBookItemBody.Rd @@ -39,18 +39,18 @@ Create codebook item body. } \section{Methods (by class)}{ \itemize{ -\item \code{default}: Default codeBookItemBody. +\item \code{codeBookItemBody(default)}: Default codeBookItemBody. -\item \code{CategoricalVariable}: Creates item body for CategoricalVariable +\item \code{codeBookItemBody(CategoricalVariable)}: Creates item body for CategoricalVariable -\item \code{CategoricalArrayVariable}: Creates item body for CategoricalArrayVariable +\item \code{codeBookItemBody(CategoricalArrayVariable)}: Creates item body for CategoricalArrayVariable -\item \code{MultipleResponseVariable}: Creates item body for MultipleResponseVariable +\item \code{codeBookItemBody(MultipleResponseVariable)}: Creates item body for MultipleResponseVariable -\item \code{DatetimeVariable}: Creates item body for DatetimeVariable +\item \code{codeBookItemBody(DatetimeVariable)}: Creates item body for DatetimeVariable -\item \code{NumericVariable}: Creates item body for NumericVariable +\item \code{codeBookItemBody(NumericVariable)}: Creates item body for NumericVariable -\item \code{TextVariable}: Creates item body for TextVariable -}} +\item \code{codeBookItemBody(TextVariable)}: Creates item body for TextVariable +}} diff --git a/man/codeBookSummary.Rd b/man/codeBookSummary.Rd index c37eb48..3032dfe 100644 --- a/man/codeBookSummary.Rd +++ b/man/codeBookSummary.Rd @@ -45,24 +45,24 @@ into either a kable or manually glued into a latex. } \section{Methods (by class)}{ \itemize{ -\item \code{default}: The default, throws out anything that does not +\item \code{codeBookSummary(default)}: The default, throws out anything that does not match expected crunch variable classes -\item \code{factor}: Prepares a codeBookSummary data.frame for a factor +\item \code{codeBookSummary(factor)}: Prepares a codeBookSummary data.frame for a factor -\item \code{CategoricalVariable}: Prepares a codeBookSummary data.frame for a +\item \code{codeBookSummary(CategoricalVariable)}: Prepares a codeBookSummary data.frame for a CategoricalVariable -\item \code{MultipleResponseVariable}: Prepares a codeBookSummary data.frame for a +\item \code{codeBookSummary(MultipleResponseVariable)}: Prepares a codeBookSummary data.frame for a MultipleResponseVariable -\item \code{CategoricalArrayVariable}: Prepares a codeBookSummary data.frame for a +\item \code{codeBookSummary(CategoricalArrayVariable)}: Prepares a codeBookSummary data.frame for a CategoricalArrayVariable -\item \code{NumericVariable}: Prepares a codeBookSummary data.frame for a NumericVariable +\item \code{codeBookSummary(NumericVariable)}: Prepares a codeBookSummary data.frame for a NumericVariable -\item \code{TextVariable}: Prepares a codeBookSummary data.frame for a TextVariable +\item \code{codeBookSummary(TextVariable)}: Prepares a codeBookSummary data.frame for a TextVariable -\item \code{DatetimeVariable}: Prepares a codeBookSummary data.frame for a DatetimeVaraible -}} +\item \code{codeBookSummary(DatetimeVariable)}: Prepares a codeBookSummary data.frame for a DatetimeVaraible +}} diff --git a/man/crosstabs.Rd b/man/crosstabs.Rd index 773b948..7501e3e 100644 --- a/man/crosstabs.Rd +++ b/man/crosstabs.Rd @@ -75,9 +75,9 @@ summaries of a Cruch dataset. } \section{Functions}{ \itemize{ -\item \code{toplines}: An alias for \code{crosstabs} -}} +\item \code{toplines()}: An alias for \code{crosstabs} +}} \examples{ \dontrun{ toplines_summary <- crosstabs(crunch_dataset, weight = "weight") diff --git a/man/crunchtabs-package.Rd b/man/crunchtabs-package.Rd index bcaba94..3d512a5 100644 --- a/man/crunchtabs-package.Rd +++ b/man/crunchtabs-package.Rd @@ -6,11 +6,7 @@ \alias{crunchtabs-package} \title{crunchtabs: Custom Report Generation for Crunch Datasets} \description{ -In order to generate custom survey reports, this package provides - functions for computing 'toplines' (one-way frequency summaries), - 'banners' (cross-tabulations) and codebooks of datasets in the Crunch - () web service. Reports can be written in 'PDF' format - using 'LaTeX' or in Microsoft Excel '.xlsx' files. +In order to generate custom survey reports, this package provides functions for computing 'toplines' (one-way frequency summaries), 'banners' (cross-tabulations) and codebooks of datasets in the Crunch (\url{https://crunch.io/}) web service. Reports can be written in 'PDF' format using 'LaTeX' or in Microsoft Excel '.xlsx' files. crunchtabs provides tools for generating reports (Toplines and Banners) }