Had missed a name change in the build ignore, and added dont run to o…

…ne example

.Rbuildignore

@@ -5,9 +5,9 @@
 ^\.covrignore$
 ^codecov\.yml$
 ^\.github$
-^pvutils\.Rcheck$
-^pvutils.*\.tar\.gz$
-^pvutils.*\.tgz$
+^pvda\.Rcheck$
+^pvda.*\.tar\.gz$
+^pvda.*\.tgz$
 ^LICENSE\.md$
 ^data-raw$
 ^_pkgdown\.yml$

R/da_object_oriented_functions.R

@@ -39,9 +39,12 @@
 #'     group_by = "group"
 #'   )
 #'
-#' da_2 <-
+#'
+#' \dontrun{
+#'  da_2 <-
 #'   drug_event_df |>
 #'   da(df_colnames = list_of_colnames)
+#' }
 #'
 #' # If columns in your df have different names than the default ones,
 #' # you can specify the column names in the df_colnames parameter list:

README.md

@@ -1,6 +1,6 @@
 # pvda
 
-An R package for executing disproportionality analyses with information component (IC) proportional reporting rate (PRR) and reporting odds ratio (ROR). 
+An R package for executing disproportionality analyses with information component (IC), proportional reporting rate (PRR) and reporting odds ratio (ROR). 
 
 <!-- badges: start -->
 [![Codecov test coverage](https://codecov.io/gh/OskarGauffin/pvutils/branch/main/graph/badge.svg)](https://app.codecov.io/gh/OskarGauffin/pvutils?branch=main)
@@ -11,25 +11,33 @@ An R package for executing disproportionality analyses with information componen
 # Installation
 
 ``` r
-# Install from GitHub:
+# Install development version from GitHub:
 devtools::install_github("OskarGauffin/pvda")
 
 # Not yet on CRAN, but once there:
 # install.packages("pvda")
 ```
 
 # Example code
+To run a disproportionality analysis, pass the adverse event report-level data to function *da* as:
 
 ``` r
 library("pvda")
 
 da1 <- 
 drug_event_df |> 
-pvda::da()
+da()
 
 summary(da1)
 ```
 
+The output object contains summary counts, as well as disproportionality point and interval estimates, and can be accessed as a regular list object:
+
+``` r
+
+da_results <- 
+da1$da_df
+```
 
 
 

crancomments.md

@@ -3,7 +3,33 @@
 * github actions: ubuntu-latest (devel, release, oldrel-1), 
                   macos-latest (release), 
                   windows-latest (release)
+
+0 Errors | 0 Warnings | O Notes
+
+* rhub - Ubuntu Linux 20.04.1 LTS, R-release, GCC
+         Windows Server 2022, R-devel, 64 bit
+
+NOTES (both platforms together):
+
+Possibly misspelled words in DESCRIPTION:
+  disproportionality (7:48)
+  Disproportionality (3:8)
+  Pharmacovigilance (3:41)
+
+COMMENT: These words are not misspelled. 
+
+* checking HTML version of manual ... NOTE
+Skipping checking HTML validation: no command 'tidy' found
+Skipping checking math rendering: package 'V8' unavailable
+
+* checking for non-standard things in the check directory ... NOTE
+Found the following files/directories:
+  ''NULL''
+
+* checking for detritus in the temp directory ... NOTE
+Found the following files/directories:
+  'lastMiKTeXException'
+
+COMMENT: From questions and answers on stack overflow, these notes do not seem related to the submitted package. 
 
 
-## R CMD check
-* No errors, warnings or notes