Release 0.1.0 (#12)

R4GoodAcademy · Dec 29, 2024 · 5fff8ff · 5fff8ff
1 parent e4d79c4
commit 5fff8ff
Show file tree

Hide file tree

Showing 20 changed files with 168 additions and 25 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -12,3 +12,4 @@
 ^.vscode$
 ^\.github$
 ^data-raw$
+^cran-comments\.md$
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -26,6 +26,7 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libmagick++-dev
+          sudo apt-get install -y libgit2-1.7
 
       - uses: r-lib/actions/setup-r@v2
         with:

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,36 +1,38 @@
 Package: R4GoodPersonalFinances
 Title: Make Better Financial Decisions
-Version: 0.0.0.9025
+Version: 0.1.0
 Authors@R: c(
     person("Kamil", "Wais", , "[email protected]", role = c("aut", "cre", "cph", "fnd"),
            comment = c(ORCID = "0000-0002-4062-055X")),
     person("Olesia", "Wais", , "[email protected]", role = "aut",
            comment = c(ORCID = "0000-0002-8741-8674"))
   )
 Description: Make informed, data-driven decisions for your personal or
-    household finances.  Use tools and methods that are selected carefully
+    household finances. Use tools and methods that are selected carefully
     to align with academic consensus, bridging the gap between theoretical
-    knowledge and practical application.  They assist you in finding
+    knowledge and practical application. They assist you in finding
     optimal asset allocation, preparing for retirement or financial
     independence, calculating optimal spending, and more.
 License: MIT + file LICENSE
-URL: https://www.r4good.academy/, https://r4goodacademy.github.io/R4GoodPersonalFinances/, https://github.com/R4GoodAcademy/R4GoodPersonalFinances
+URL: https://www.r4good.academy/,
+    https://r4goodacademy.github.io/R4GoodPersonalFinances/,
+    https://github.com/R4GoodAcademy/R4GoodPersonalFinances
 BugReports: https://github.com/R4GoodAcademy/R4GoodPersonalFinances/issues
 Depends: 
     R (>= 4.1.0)
 Imports: 
+    bsicons,
+    bslib,
     dplyr,
     ggplot2,
     ggrepel,
     ggtext,
     glue,
-    withr,
     PrettyCols,
     scales,
-    tidyr,
     shiny,
-    bslib,
-    bsicons
+    tidyr,
+    withr
 Suggests: 
     testthat (>= 3.0.0),
     vdiffr

diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2024
+YEAR: 2025
 COPYRIGHT HOLDER: Kamil Wais
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 R4GoodPersonalFinances authors
+Copyright (c) 2025 Kamil Wais
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,4 @@
-# R4GoodPersonalFinances (development version)
-
-# R4GoodPersonalFinances 0.0.0.9016
+# R4GoodPersonalFinances 0.1.0
 
 Initial release of the package includes functions designed to 
 support the optimal allocation of your investment portfolio

diff --git a/R/R4GoodPersonalFinances-package.R b/R/R4GoodPersonalFinances-package.R
@@ -11,9 +11,22 @@ NULL
   packageStartupMessage(
     glue::glue("Welcome to {pkgname} version {pkg_version}!")
   )
+
+  packageStartupMessage(
+    "Cite the package: citation('R4GoodPersonalFinances')"
+  )
+
+  packageStartupMessage(
+    "Package documentation: https://r4goodacademy.github.io/R4GoodPersonalFinances/"
+  )
+
   packageStartupMessage(
     "To learn more, visit: https://www.r4good.academy/"
   )
+
+  packageStartupMessage(
+    "... and Make Better Financial Decisions!"
+  )
 }
 
 ignore_unused_imports <- function() {

diff --git a/R/run_app.R b/R/run_app.R
@@ -11,6 +11,12 @@
 #' 
 #' @param shinylive A logical. Whether to use `shinylive` for the app.
 #' 
+#' @returns A [shiny::shinyApp()] object if `shinylive` is `TRUE`.
+#' Runs the app if `shinylive` is `FALSE` with [shiny::runApp()].
+#'
+#' @examplesIf interactive()
+#' run_app("risk-adjusted-returns")
+#' run_app("purchasing-power")
 #' @export
 run_app <- function(
   which = c(

diff --git a/R/sysdata.rda b/R/sysdata.rda
diff --git a/R/utils.R b/R/utils.R
@@ -8,6 +8,8 @@
 #' @inheritParams scales::percent
 #' @rdname print_
 #' 
+#' @return A character. Formatted value.
+#' 
 #' @examples
 #' print_currency(2345678, suffix = " PLN")
 #' @export
@@ -33,6 +35,8 @@ print_currency <- function(x,
 #' @inheritParams scales::dollar
 #' @rdname print_
 #' 
+#' @return A character. Formatted value.
+#' 
 #' @examples
 #' print_percent(0.52366)
 #' @export

diff --git a/README.Rmd b/README.Rmd
@@ -18,6 +18,9 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![R-CMD-check](https://github.com/R4GoodAcademy/R4GoodPersonalFinances/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/R4GoodAcademy/R4GoodPersonalFinances/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/R4GoodAcademy/R4GoodPersonalFinances/graph/badge.svg)](https://app.codecov.io/gh/R4GoodAcademy/R4GoodPersonalFinances)
+[![R4GoodPersonalFinances status badge](https://r4goodacademy.r-universe.dev/badges/R4GoodPersonalFinances)](https://r4goodacademy.r-universe.dev/R4GoodPersonalFinances)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)
+[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 <!-- badges: end -->
 
 > *Make Better Financial Decisions*
@@ -32,13 +35,29 @@ These tools are selected carefully to align with academic consensus, bridging th
 
 ## Installation
 
+### Installation from GitHub
+
 You can install the latest version of R4GoodPersonalFinances from [GitHub](https://github.com/R4GoodAcademy/R4GoodPersonalFinances) with:
 
 ``` r
 # install.packages("pak")
 pak::pak("R4GoodAcademy/R4GoodPersonalFinances")
 ```
 
+### Installation from R-universe
+
+You can install the package from [R-universe](https://r4goodacademy.r-universe.dev/R4GoodPersonalFinances) also as `WebAssembly` (WASM) binaries for use in WebR applications:
+
+``` r
+install.packages(
+  "R4GoodPersonalFinances", 
+  repos = c(
+    "https://r4goodacademy.r-universe.dev", 
+    "https://cloud.r-project.org"
+  )
+)
+```
+
 ## Acknowledgments
 
 * Haghani V., White J. (2023) "The Missing Billionaires: A Guide to Better Financial Decisions." `ISBN:978-1-119-74791-8`.
@@ -50,4 +69,7 @@ The `R4GoodPersonalFinances` R package is part of the *R for Good Academy* proje
 
 * [How to Determine Our Optimal Asset Allocation?](https://www.r4good.academy/en/blog/optimal-asset-allocation/index.en.html#what-do-you-need-to-calculate-your-optimal-asset-allocation)
 
+The official package documentation can be found here:  
+[r4goodacademy.github.io/R4GoodPersonalFinances](https://r4goodacademy.github.io/R4GoodPersonalFinances/)
+
 > *Make Better Financial Decisions* with the `R4GoodPersonalFinances` R package!
diff --git a/README.md b/README.md
@@ -8,6 +8,10 @@
 [![R-CMD-check](https://github.com/R4GoodAcademy/R4GoodPersonalFinances/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/R4GoodAcademy/R4GoodPersonalFinances/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/R4GoodAcademy/R4GoodPersonalFinances/graph/badge.svg)](https://app.codecov.io/gh/R4GoodAcademy/R4GoodPersonalFinances)
+[![R4GoodPersonalFinances status
+badge](https://r4goodacademy.r-universe.dev/badges/R4GoodPersonalFinances)](https://r4goodacademy.r-universe.dev/R4GoodPersonalFinances)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://choosealicense.com/licenses/mit/)
+[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 <!-- badges: end -->
 
 > *Make Better Financial Decisions*
@@ -26,6 +30,8 @@ application. They assist you in:
 
 ## Installation
 
+### Installation from GitHub
+
 You can install the latest version of R4GoodPersonalFinances from
 [GitHub](https://github.com/R4GoodAcademy/R4GoodPersonalFinances) with:
 
@@ -34,6 +40,22 @@ You can install the latest version of R4GoodPersonalFinances from
 pak::pak("R4GoodAcademy/R4GoodPersonalFinances")
 ```
 
+### Installation from R-universe
+
+You can install the package from
+[R-universe](https://r4goodacademy.r-universe.dev/R4GoodPersonalFinances)
+also as `WebAssembly` (WASM) binaries for use in WebR applications:
+
+``` r
+install.packages(
+  "R4GoodPersonalFinances", 
+  repos = c(
+    "https://r4goodacademy.r-universe.dev", 
+    "https://cloud.r-project.org"
+  )
+)
+```
+
 ## Acknowledgments
 
 - Haghani V., White J. (2023) “The Missing Billionaires: A Guide to
@@ -51,5 +73,8 @@ example:
 - [How to Determine Our Optimal Asset
   Allocation?](https://www.r4good.academy/en/blog/optimal-asset-allocation/index.en.html#what-do-you-need-to-calculate-your-optimal-asset-allocation)
 
+The official package documentation can be found here:  
+[r4goodacademy.github.io/R4GoodPersonalFinances](https://r4goodacademy.github.io/R4GoodPersonalFinances/)
+
 > *Make Better Financial Decisions* with the `R4GoodPersonalFinances` R
 > package!
diff --git a/cran-comments.md 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/devel/deploy.R b/devel/deploy.R
@@ -19,18 +19,36 @@ devtools::build_readme()
 pkgdown::build_site(preview = FALSE)
 pkgdown::preview_site()
 
-roxygen2md::roxygen2md()
+# roxygen2md::roxygen2md()
 
 spelling::spell_check_package()
 spelling::update_wordlist()
 
 citation("R4GoodPersonalFinances")
 
 urlchecker::url_check()
+urlchecker::url_update()
 
 usethis::use_tidy_description()
 
 devtools::test_coverage()
 
-usethis::use_github_action()
-usethis::use_pkgdown_github_pages()
+# usethis::use_github_action()
+# usethis::use_pkgdown_github_pages()
+
+
+citation <- readLines("inst/CITATION")
+citation
+current_year <- lubridate::year(Sys.Date())
+current_year <- 2025
+citation[5] <- glue::glue("  year     = {current_year},")
+citation[6] <- glue::glue("  note     = \"{sprintf(\"R package version %s, https://r4goodacademy.github.io/R4GoodPersonalFinances/\", as.character(packageVersion(\"R4GoodPersonalFinances\")))} \",")
+citation
+writeLines(citation, "inst/CITATION")
+devtools::load_all()
+citation('R4GoodPersonalFinances')
+
+usethis::use_cran_comments()
+
+devtools::check(remote = TRUE, manual = TRUE)
+
diff --git a/devel/r4gpf-hex-640.png b/devel/r4gpf-hex-640.png
diff --git a/inst/CITATION b/inst/CITATION
@@ -1,9 +1,8 @@
-package_version <- utils::packageDescription("R4GoodPersonalFinances")$Version
 bibentry(
   bibtype  = "Manual",
   title    = "R4GoodPersonalFinances: Make Better Financial Decisions",
   author   = c(person("Kamil", "Wais"), person("Olesia", "Wais")),
-  year     = 2024,
-  note     = sprintf("R package version %s, https://github.com/R4GoodAcademy/R4GoodPersonalFinances", package_version),
+  year     = 2025,
+  note     = "R package version 0.1.0, https://r4goodacademy.github.io/R4GoodPersonalFinances/ ",
   url      = "https://www.r4good.academy/"
 )
diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -1,6 +1,14 @@
+CMD
+Codecov
 GoodPersonalFinances
 Haghani
 ORCID
+WASM
+WebR
 funder
+github
+goodacademy
+io
+lifecycle
 rescaled
 www
diff --git a/man/print_.Rd b/man/print_.Rd
diff --git a/man/run_app.Rd b/man/run_app.Rd