fix: fix and improvemets

DiogoRibeiro7 · DiogoRibeiro7 · commit ddeb58b4d626 · 2025-08-17T00:21:56.000+01:00
diff --git a/.github/workflows/pr-commands.yaml b/.github/workflows/pr-commands.yaml
@@ -52,7 +52,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/pr-fetch@v2
         with:
diff --git a/.lintr b/.lintr
@@ -5,7 +5,7 @@ linters: linters_with_defaults(
   )
 exclusions: list(
     "inst/",
-    "man/",
-    "vignettes/"
+    "man/"
+    # Removed "vignettes/" to enforce linting on vignettes
   )
 encoding: "UTF-8"
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,10 +1,13 @@
 Package: myrpackage
 Type: Package
-Title: A Minimal R Package
-Version: 0.0.0.9000
+Title: Multilingual Greeting and Farewell Functions
+Version: 0.1.0
 Authors@R:
     person(given = "Diogo", family = "Ribeiro", email = "dfr@esmad.ipp.pt", role = c("aut", "cre"), comment = c(ORCID = "0009-0001-2022-7072", affiliation = "ESMAD - Instituto Politécnico do Porto"))
-Description: A short description of what the package does.
+Description: Provides functions for greeting and saying farewell in multiple languages.
+    The package supports English, Spanish, French, Portuguese, German, and Italian.
+    It demonstrates proper R package structure, documentation, and testing practices.
+    Functions include customization options for formatting and punctuation.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
diff --git a/NEWS.md b/NEWS.md
@@ -1,24 +1,27 @@
 # myrpackage NEWS
 
-## myrpackage 0.0.0.9000 (Development version)
+## myrpackage 0.1.0
 
 ### New features
 
 * Added `hello()` function for multilingual greetings
 * Added `goodbye()` function for multilingual farewells
 * Added comprehensive documentation and examples
 * Added unit tests for all functions
+* Added support for name capitalization in both functions
+* Added proper language validation with helpful warnings
 
 ### Package structure
 
 * Initial package setup with proper R package structure
-* Added vignette for package introduction
+* Added vignettes for package introduction and advanced usage
 * Added continuous integration with GitHub Actions
 * Added code coverage tracking
 * Added package website with pkgdown
 
 ### Improvements
 
 * Added input validation to all functions
-* Added support for multiple languages (English, Spanish, French, Portuguese)
+* Added support for multiple languages (English, Spanish, French, Portuguese, German, Italian)
 * Added proper documentation with roxygen2
+* Implemented utility functions for common operations
diff --git a/R/myrpackage-package.R b/R/myrpackage-package.R
@@ -1,19 +1,29 @@
 #' @keywords internal
 "_PACKAGE"
 
-#' myrpackage: A Minimal R Package
+#' myrpackage: A Multilingual Greeting Package
 #'
 #' @description
-#' A minimal R package that provides greeting functions.
-#' This package is designed to demonstrate proper R package structure
-#' and documentation practices.
+#' A friendly R package that provides greeting and farewell functions in multiple languages.
+#' This package demonstrates proper R package structure, documentation, and test practices.
+#' It is designed to be a simple but complete example of R package development.
 #'
 #' @section Main functions:
 #' \itemize{
 #'   \item \code{\link{hello}} - Say hello in various languages
 #'   \item \code{\link{goodbye}} - Say goodbye in various languages
 #' }
 #'
+#' @section Supported languages:
+#' \itemize{
+#'   \item English (default)
+#'   \item Spanish
+#'   \item French
+#'   \item Portuguese
+#'   \item German
+#'   \item Italian
+#' }
+#'
 #' @docType package
 #' @name myrpackage-package
 NULL
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
-# myrpackage
+# myrpackage <img src="man/figures/logo.png" align="right" height="139" alt="myrpackage logo" />
 
 <!-- badges: start -->
 [![R-CMD-check](https://github.com/DiogoRibeiro7/myrpackage/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/DiogoRibeiro7/myrpackage/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/DiogoRibeiro7/myrpackage/branch/main/graph/badge.svg)](https://codecov.io/gh/DiogoRibeiro7/myrpackage?branch=main)
 [![CRAN status](https://www.r-pkg.org/badges/version/myrpackage)](https://CRAN.R-project.org/package=myrpackage)
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 <!-- badges: end -->
 
-A minimal R package scaffold, structured for publication on [CRAN](https://cran.r-project.org/), with boilerplate files and metadata to begin development immediately.
+A friendly R package that provides greeting and farewell functions in multiple languages.
 
 ## Installation
 
@@ -41,22 +41,49 @@ hello("amigos", language = "spanish")
 hello("mes amis", language = "french")
 #> Bonjour, mes amis!
 
+# Say hello with capitalization
+hello("r users", capitalize = TRUE)
+#> Hello, R users!
+
 # Say goodbye
 goodbye()
 #> Goodbye, world!
 
 goodbye("friends", language = "portuguese")
 #> Adeus, friends!
+
+# Customize punctuation
+goodbye("everyone", exclamation = FALSE)
+#> Goodbye, everyone.
 ```
 
 ## Features
 
-- 🌐 Multilingual greeting and farewell functions
+- 🌐 Multilingual greeting and farewell functions in 6 languages
+- 🔠 Text formatting options including capitalization
 - 📦 Proper R package structure
 - 📄 Comprehensive documentation
 - 🧪 Complete test coverage
 - 🔄 Continuous Integration workflow
 
+## Supported Languages
+
+- English (default)
+- Spanish
+- French
+- Portuguese
+- German
+- Italian
+
+## Function Options
+
+Both `hello()` and `goodbye()` support these parameters:
+
+- `name`: Who to greet (default: "world")
+- `language`: Language to use (default: "english")
+- `exclamation`: Whether to add an exclamation mark (default: TRUE)
+- `capitalize`: Whether to capitalize the name (default: FALSE)
+
 ## Package Structure
 
 ```
@@ -66,16 +93,15 @@ myrpackage/
 ├── R/                  # R source code
 │   ├── hello.R         # Hello function
 │   ├── goodbye.R       # Goodbye function
+│   ├── utils.R         # Utility functions
 │   ├── lifecycle.R     # Lifecycle definitions
 │   └── myrpackage-package.R  # Package documentation
 ├── man/                # Documentation
 ├── tests/              # Tests
 │   └── testthat/       # Unit tests
 ├── vignettes/          # Long-form documentation
-│   └── intro.Rmd       # Introduction vignette
-├── .Rbuildignore       # Build exclusions
-├── .github/            # GitHub configuration
-│   └── workflows/      # CI/CD workflows
+│   ├── intro.Rmd       # Introduction vignette
+│   └── advanced.Rmd    # Advanced usage vignette
 ├── inst/               # Installed files
 │   └── CITATION        # Citation information
 └── LICENSE             # MIT license
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -28,11 +28,14 @@ navbar:
       menu:
       - text: Getting Started
         href: articles/intro.html
+      - text: Advanced Usage
+        href: articles/advanced.html
     reference:
       text: Reference
       href: reference/index.html
     github:
       icon: fab fa-github fa-lg
+      aria-label: GitHub
       href: https://github.com/DiogoRibeiro7/myrpackage
     news:
       text: News
@@ -48,8 +51,8 @@ reference:
   - title: "Package Information"
     desc: "Documentation about the package itself"
     contents:
-      - "myrpackage-package"  # Use quotes to ensure it's treated as a literal string
-      - myrpackage-lifecycle
+      - "myrpackage-package"
+      - "myrpackage-lifecycle"
 
 home:
   sidebar:
diff --git a/codecov.yml b/codecov.yml
@@ -6,9 +6,11 @@ coverage:
       default:
         target: auto
         threshold: 1%
-        informational: true
+        # Changed from informational to true to make codecov status checks required
+        informational: false
     patch:
       default:
         target: auto
         threshold: 1%
-        informational: true
+        # Changed from informational to true to make codecov status checks required
+        informational: false
diff --git a/inst/CITATION b/inst/CITATION
@@ -5,7 +5,7 @@ version <- meta$Version
 
 bibentry(
   bibtype = "Manual",
-  title = "myrpackage: A Minimal R Package",
+  title = "myrpackage: Multilingual Greeting and Farewell Functions",
   author = person(given = "Diogo", family = "Ribeiro",
                   email = "dfr@esmad.ipp.pt",
                   role = c("aut", "cre"),
@@ -17,7 +17,7 @@ bibentry(
   doi = "", # Add DOI when available
   textVersion = paste0(
     "Ribeiro, D. (", year, "). ",
-    "myrpackage: A Minimal R Package. ",
+    "myrpackage: Multilingual Greeting and Farewell Functions. ",
     "R package version ", version, ". ",
     "https://github.com/DiogoRibeiro7/myrpackage"
   )
diff --git a/tests/testthat/test-goodbye.R b/tests/testthat/test-goodbye.R
@@ -24,8 +24,15 @@ test_that("goodbye() supports different languages", {
   # Test Portuguese
   expect_output(goodbye(language = "portuguese"), "Adeus, world!")
 
-  # Test unknown language (should default to English)
-  expect_output(goodbye(language = "german"), "Goodbye, world!")
+  # Test German
+  expect_output(goodbye(language = "german"), "Auf Wiedersehen, world!")
+
+  # Test Italian
+  expect_output(goodbye(language = "italian"), "Arrivederci, world!")
+
+  # Test unknown language (should default to English with warning)
+  expect_warning(goodbye(language = "german2"), "Language 'german2' not supported")
+  expect_output(suppressWarnings(goodbye(language = "german2")), "Goodbye, world!")
 })
 
 test_that("goodbye() correctly handles exclamation parameter", {
@@ -36,6 +43,14 @@ test_that("goodbye() correctly handles exclamation parameter", {
   expect_output(goodbye(exclamation = FALSE), "Goodbye, world.")
 })
 
+test_that("goodbye() correctly handles capitalize parameter", {
+  # Test with capitalize = FALSE (default)
+  expect_output(goodbye("world", capitalize = FALSE), "Goodbye, world!")
+
+  # Test with capitalize = TRUE
+  expect_output(goodbye("world", capitalize = TRUE), "Goodbye, World!")
+})
+
 test_that("goodbye() validates input parameters", {
   # Test invalid name parameter
   expect_error(goodbye(name = c("world", "everyone")), "'name' must be a single character string")
@@ -48,12 +63,16 @@ test_that("goodbye() validates input parameters", {
   # Test invalid exclamation parameter
   expect_error(goodbye(exclamation = c(TRUE, FALSE)), "'exclamation' must be a single logical value")
   expect_error(goodbye(exclamation = "yes"), "'exclamation' must be a single logical value")
+
+  # Test invalid capitalize parameter
+  expect_error(goodbye(capitalize = c(TRUE, FALSE)), "'capitalize' must be a single logical value")
+  expect_error(goodbye(capitalize = "yes"), "'capitalize' must be a single logical value")
 })
 
 test_that("goodbye() works with all combinations of parameters", {
   # Test with all parameters customized
   expect_output(
-    goodbye(name = "friends", language = "spanish", exclamation = FALSE),
-    "Adiós, friends."
+    goodbye(name = "friends", language = "spanish", exclamation = FALSE, capitalize = TRUE),
+    "Adiós, Friends."
   )
 })
diff --git a/tests/testthat/test-hello.R b/tests/testthat/test-hello.R
diff --git a/tests/testthat/test-utils.R b/tests/testthat/test-utils.R
diff --git a/vignettes/advanced.Rmd b/vignettes/advanced.Rmd
diff --git a/vignettes/intro.Rmd b/vignettes/intro.Rmd

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ linters: linters_with_defaults(`
`5`	`5`	`)`
`6`	`6`	`exclusions: list(`
`7`	`7`	`"inst/",`
`8`		`- "man/",`
`9`		`- "vignettes/"`
	`8`	`+ "man/"`
	`9`	`+ # Removed "vignettes/" to enforce linting on vignettes`
`10`	`10`	`)`
`11`	`11`	`encoding: "UTF-8"`