diff --git a/.Rbuildignore b/.Rbuildignore index 6316035..180e0cb 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -20,3 +20,4 @@ $run_dev.* ^.covrignore$ ^codecov\.yml$ ^.lintr$ +^cran-comments\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index 0d901ce..677bdaf 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,13 +1,13 @@ Package: ordinalsimr -Title: Ordinal Endpoint Comparisons -Version: 0.0.0.9003 +Title: Compare Ordinal Endpoints Esing Simulations +Version: 0.1.0 Authors@R: person(given = "Pat", family = "Callahan", - role = c("aut", "cre"), + role = c("aut", "cre", "cph"), email = "patricktcallahan18@gmail.com", comment = c(ORCID = "0000-0003-1769-7580")) -Description: Simultaneously evaluate multiple ordinal outcome measures. +Description: Simultaneously evaluate multiple ordinal outcome measures. Applied data analysts in particular are faced with uncertainty in choosing appropriate statistical tests for ordinal data. The included Shiny applications allows users to simulate outcomes given different ordinal data distributions. License: MIT + file LICENSE Imports: assertthat, @@ -46,5 +46,5 @@ Suggests: writexl Config/testthat/edition: 3 Depends: - R (>= 3.5.10) + R (>= 4.4.0) VignetteBuilder: knitr diff --git a/NEWS.md b/NEWS.md index b64c23f..c04f8af 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# ordinalsimr (development version) +# ordinalsimr 0.1.0 * Significantly refined the UI * Allowed more options for pre-setting simulation inputs, created a .onLoad to set some of these values, and created the `set_ordinalsimr_options` function to allow users to set these values themselves. diff --git a/README.Rmd b/README.Rmd index 03bdb5d..6819dae 100644 --- a/README.Rmd +++ b/README.Rmd @@ -41,9 +41,8 @@ devtools::install_github( ## Recommendations -The application is available at [link], but may be down due to account usage limitations on ShinyApps.io. There is not currently a plan to increase the usage limits so it is *strongly recommended that you run the application locally*. +Simulations with 1000s of iterations *will* take minutes to hours to run. This should generally be ok on the Shiny app, but if you encounter issues, consider running the simulations in a separate R session using the functions provided in this package (rather than the Shiny app). -Informative progressive bars have not been implemented in the Shiny application, but a simulation that fails to run will almost always fail at the beginning rather than in the middle of the run. Simulations with 1000s of iterations *will* take minutes to hours to run. diff --git a/README.md b/README.md index d509dca..8b13c6c 100644 --- a/README.md +++ b/README.md @@ -47,12 +47,7 @@ devtools::install_github( ## Recommendations -The application is available at \[link\], but may be down due to account -usage limitations on ShinyApps.io. There is not currently a plan to -increase the usage limits so it is *strongly recommended that you run -the application locally*. - -Informative progressive bars have not been implemented in the Shiny -application, but a simulation that fails to run will almost always fail -at the beginning rather than in the middle of the run. Simulations with -1000s of iterations *will* take minutes to hours to run. +Simulations with 1000s of iterations *will* take minutes to hours to +run. This should generally be ok on the Shiny app, but if you encounter +issues, consider running the simulations in a separate R session using +the functions provided in this package (rather than the Shiny app). diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..858617d --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,5 @@ +## R CMD check results + +0 errors | 0 warnings | 1 note + +* This is a new release. diff --git a/man/ordinalsimr-package.Rd b/man/ordinalsimr-package.Rd index 180afd1..543f220 100644 --- a/man/ordinalsimr-package.Rd +++ b/man/ordinalsimr-package.Rd @@ -4,9 +4,9 @@ \name{ordinalsimr-package} \alias{ordinalsimr} \alias{ordinalsimr-package} -\title{ordinalsimr: Ordinal Endpoint Comparisons} +\title{ordinalsimr: Compare Ordinal Endpoints Esing Simulations} \description{ -Simultaneously evaluate multiple ordinal outcome measures. +Simultaneously evaluate multiple ordinal outcome measures. Applied data analysts in particular are faced with uncertainty in choosing appropriate statistical tests for ordinal data. The included Shiny applications allows users to simulate outcomes given different ordinal data distributions. } \seealso{ Useful links: @@ -18,7 +18,7 @@ Useful links: } \author{ -\strong{Maintainer}: Pat Callahan \email{patricktcallahan18@gmail.com} (\href{https://orcid.org/0000-0003-1769-7580}{ORCID}) +\strong{Maintainer}: Pat Callahan \email{patricktcallahan18@gmail.com} (\href{https://orcid.org/0000-0003-1769-7580}{ORCID}) [copyright holder] } \keyword{internal}