Skip to contents

myrpackage myrpackage logo

A friendly R package that provides greeting and farewell functions in multiple languages.

Installation

You can install the development version of myrpackage from GitHub with:

# install.packages("devtools")
devtools::install_github("DiogoRibeiro7/myrpackage")

Usage

Basic Examples 

library(myrpackage)

# Say hello with default parameters
hello()
#> Hello, world!

# Say hello to someone specific
hello("R Users")
#> Hello, R Users!

# Say hello in different languages
hello("amigos", language = "spanish")
#> Hola, amigos!

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 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 

myrpackage/
├── DESCRIPTION          # Package metadata
├── NAMESPACE           # Exported functions
├── 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
│   └── advanced.Rmd    # Advanced usage vignette
├── inst/               # Installed files
│   └── CITATION        # Citation information
└── LICENSE             # MIT license

Development

Getting Started

  1. Clone the repository
  2. Open the project in RStudio or your preferred R environment
  3. Install development dependencies with devtools::install_dev_deps()

Running Tests 

# Run tests
devtools::test()

# Check test coverage
covr::package_coverage()

Building Documentation 

# Generate documentation
devtools::document()

# Build vignettes
devtools::build_vignettes()

# Preview package website
pkgdown::build_site()

Quality Checks 

# Run R CMD check
devtools::check()

# Check package with more stringent CRAN checks
rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"))

# Lint code
lintr::lint_package()

# Style code
styler::style_pkg()

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

To cite this package, please use:

citation("myrpackage")