Merge pull request #123 from sunroofgod/effsize

Effsize

.Rbuildignore

@@ -5,3 +5,8 @@
 ^docs$
 ^pkgdown$
 ^\.github$
+^README\.Rmd$
+^CODE_OF_CONDUCT.md$
+^CONTRIBUTING.MD$
+^figures$
+^dabestr.Rmd$

.github/workflows/R-CMD-check.yaml

@@ -1,29 +1,29 @@
-# # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
-# # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
-# on:
-#   push:
-#     branches: [dev]
-#   pull_request:
-#     branches: [dev]
-# 
-# name: R-CMD-check
-# 
-# jobs:
-#   R-CMD-check:
-#     runs-on: ubuntu-latest
-#     env:
-#       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
-#       R_KEEP_PKG_SOURCE: yes
-#     steps:
-#       - uses: actions/checkout@v3
-# 
-#       - uses: r-lib/actions/setup-r@v2
-#         with:
-#           use-public-rspm: true
-# 
-#       - uses: r-lib/actions/setup-r-dependencies@v2
-#         with:
-#           extra-packages: any::rcmdcheck
-#           needs: check
-# 
-#       - uses: r-lib/actions/check-r-package@v2
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [dev]
+  pull_request:
+    branches: [dev]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dabestr
 Type: Package
 Title: Data Analysis using Bootstrap-Coupled Estimation
-Version: 0.0.0.9000
+Version: 1.0.0.0
 Authors@R: c(
   person("Kah Seng", "Lian", email = "kahseng@u.nus.edu", role = c("cre", "aut")),
   person("Zhuoyu", "Wang", email = "wzhuoyu21@u.nus,edu", role = c("aut")),

R/001_api.R

@@ -354,12 +354,13 @@ load <- function(
 #' print(dabest_obj)
 #' 
 #' @export
-print.dabest <- function(dabest_obj, ...) {
-  if (class(dabest_obj)[1] != "dabest") {
+print.dabest <- function(x, ...) {
+  if (class(x)[1] != "dabest") {
     cli::cli_abort(c("Only dabest class can be used.", 
                      "x" = "Please enter a valid entry into the function."))
   }
 
+  dabest_obj <- x
   print_greeting_header()
 
   paired <- dabest_obj$paired

R/001_effsize_func.R

@@ -10,9 +10,9 @@
 #' The following effect sizes `mean_diff`, `median_diff`, `cohens_d`, `hedges_g` and `cliffs_delta`
 #' are used for most plot types. 
 #' 
-#' @param `dabest_obj` A dabest_obj created by loading in dataset along with other 
+#' @param dabest_obj A dabest_obj created by loading in dataset along with other 
 #' specified parameters with the [load()] function.
-#' @param `perm_count` The number of reshuffles of control and test labels to be performed for each p-value.
+#' @param perm_count The number of reshuffles of control and test labels to be performed for each p-value.
 #' 
 #' @returns 
 #' Returns a `dabest_effectsize_obj` list with 22 elements. The following are the elements contained within:
@@ -312,12 +312,13 @@ hedges_correction <- function(x1, x2) {
 #' print(dabest_obj.mean_diff)
 #' 
 #' @export
-print.dabest_effectsize <- function(dabest_effectsize_obj, ...) {
-  if (class(dabest_effectsize_obj) != "dabest_effectsize") {
+print.dabest_effectsize <- function(x, ...) {
+  if (class(x) != "dabest_effectsize") {
     cli::cli_abort(c("Only dabest_effectsize objects can be used.", 
                      "x" = "Please enter a valid entry into the function."))
   }
 
+  dabest_effectsize_obj <- x
   print_greeting_header()
 
   paired <- dabest_effectsize_obj$paired

R/002_plot_themes.R

@@ -8,25 +8,19 @@ float_contrast_theme <- ggplot2::theme(plot.margin = ggplot2::unit(c(0, 0, 0, 0)
                                        axis.title.x = ggplot2::element_blank(), 
                                        axis.ticks.x = ggplot2::element_blank(),
                                        axis.title.x.bottom = ggplot2::element_blank(),
-                                       legend.title = ggplot2::element_blank(),
-                                       axis.text = ggplot2::element_text(family = "sans"),
-                                       axis.title.y = ggplot2::element_text(family = "sans"))
+                                       legend.title = ggplot2::element_blank())
 
 # Theme for top-down graph
 non_float_contrast_theme <- ggplot2::theme(plot.margin = ggplot2::unit(c(0, 0, 0, 0), "pt"),
                                            axis.line.x = ggplot2::element_blank(), 
                                            axis.title.x = ggplot2::element_blank(), 
                                            axis.ticks.x = ggplot2::element_blank(),
                                            axis.title.x.bottom = ggplot2::element_blank(),
-                                           legend.title = ggplot2::element_blank(),
-                                           axis.text = ggplot2::element_text(family = "sans"),
-                                           axis.title.y = ggplot2::element_text(family = "sans"))
+                                           legend.title = ggplot2::element_blank())
 
 # Theme for removal of all axes and labels
 remove_all_axes_theme <- ggplot2::theme(axis.line = ggplot2::element_blank(),
                                         axis.title = ggplot2::element_blank(),
                                         axis.ticks = ggplot2::element_blank(),
                                         legend.title = ggplot2::element_blank(),
-                                        plot.margin = ggplot2::unit(c(0, 0, 0, 0), "pt"),
-                                        axis.text = ggplot2::element_text(family = "sans"),
-                                        axis.title.y = ggplot2::element_text(family = "sans"))
+                                        plot.margin = ggplot2::unit(c(0, 0, 0, 0), "pt"))

README.md

@@ -50,6 +50,13 @@ git clone https://github.com/ACCLAB/dabestr
 ## Usage
 
 ``` r
+library(dabestr)
+#> 
+#> Attaching package: 'dabestr'
+#> The following object is masked from 'package:base':
+#> 
+#>     load
+
 data(twogroup_data)
 
 dabest_obj.mean_diff <- dabestr::load(data = twogroup_data, 
@@ -61,7 +68,7 @@ dabest_obj.mean_diff <- dabestr::load(data = twogroup_data,
 dabest_plot(dabest_obj.mean_diff, TRUE)
 ```
 
-![](man/figures/README-unnamed-chunk-4-1.png)<!-- -->
+![](man/figures/README-unnamed-chunk-3-1.png)<!-- -->
 
 ## Citation