Cran fixes (#10)

* update description and export s3

* update cran comments

* bump patch v

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: beeca
 Title: Binary Endpoint Estimation with Covariate Adjustment
-Version: 0.1.2
+Version: 0.1.3
 Authors@R: 
   c(person(given = "Alex", 
            family = "Przybylski", 
@@ -24,11 +24,11 @@ Authors@R:
            email = "[email protected]", 
            role = c("aut")
            ))
-Description: A lightweight package to perform estimation of marginal treatment 
-  effects for binary outcomes when using logistic regression working models with 
-  covariate adjustment (see discussions in Magirr et al (2024) <https://osf.io/9mp58/>). Implements the variance estimators of 
-  Ge et al (2011) <doi:10.1177/009286151104500409> and
-  Ye et al (2023) <doi:10.1080/24754269.2023.2205802>. 
+Description: Performs estimation of marginal treatment effects for binary 
+  outcomes when using logistic regression working models with covariate 
+  adjustment (see discussions in Magirr et al (2024) <https://osf.io/9mp58/>). 
+  Implements the variance estimators of Ge et al (2011) <doi:10.1177/009286151104500409> 
+  and Ye et al (2023) <doi:10.1080/24754269.2023.2205802>. 
 Maintainer: Alex Przybylski <[email protected]>
 License: LGPL (>= 3)
 Encoding: UTF-8

NAMESPACE

@@ -7,6 +7,7 @@ export(average_predictions)
 export(estimate_varcov)
 export(get_marginal_effect)
 export(predict_counterfactuals)
+export(sanitize_model)
 importFrom(dplyr,as_tibble)
 importFrom(lifecycle,deprecated)
 importFrom(stats,cov)

NEWS.md

@@ -1,4 +1,4 @@
-# beeca 0.1.2
+# beeca 0.1.3
 
 - Preparation for CRAN submission
 

R/sanitize.R

@@ -15,6 +15,7 @@
 #' @param ... arguments passed to or from other methods.
 #' @return if model is non-compliant will throw warnings or errors.
 #' @keywords internal
+#' @export
 sanitize_model <- function(model, ...) {
   UseMethod("sanitize_model")
 }
@@ -27,10 +28,11 @@ sanitize_model <- function(model, ...) {
 #' @importFrom stats model.frame model.matrix terms
 #' @keywords internal
 #' @export
-#' @examples \dontrun{
+#' @examples
+#' trial01$trtp <- factor(trial01$trtp)
 #' fit1 <- glm(aval ~ trtp + bl_cov, family = "binomial", data = trial01)
-#' sanitize_model(fit1, "trtp")
-#' }
+#' fit1 <- sanitize_model(fit1, "trtp")
+#'
 sanitize_model.glm <- function(model, trt, ...) {
   # sanitize variable
   sanitize_variable(model, trt)

cran-comments.md

@@ -2,15 +2,15 @@
 
 This is a resubmission. In this version I have:
 
-* Corrected URLs, DOIs, ORCID identifiers
+* Updated the description to avoid starting with "A lightweight package..."
 
-* Registered S3 methods
+* Removed unnecessary \dontrun{} wrapper for an example
 
 ## R CMD check results
 
 0 errors | 0 warnings | 1 note
 
-I am aware of one possible note: The suggested package 'margins' was very recently reinstated to CRAN and binaries may not be available for certain platforms / R versions. At time of submission it is not available for Windows r-devel. 
+I am aware of one possible note: The suggested package 'margins' was very recently reinstated to CRAN and binaries may not be available for certain platforms / R versions.
 
 ```
 * checking package dependencies ... NOTE