Creating and Publishing the text2numR Package: Step-by-Step Guide

I recently tried creating a simple R package—text2numR—with the help of ChatGPT. The process was surprisingly smooth and educational, especially for someone new to R package development. You can check out the finished project here: hasindu-k/text2numR.

Let’s walk through how it was done, step by step:


 

🔧 Step 1: Start a New Package Project

  1. Open RStudio

  2. Navigate to: File > New Project > New Directory > R Package

  3. Choose a name for your package (e.g., text2numR)

  4. Click "Create Project"

🖋️ Step 2: Add Your Functions

Create your R function files inside the /R folder:

encode_text.R

#' Encode a string into numeric positions
#'
#' @param text A character string
#' @return A numeric vector
#' @export
encode_text <- function(text) {
  chars <- strsplit(tolower(text), "")[[1]]
  match(chars, letters)
}

decode_text.R

#' Decode numeric positions into a string
#'
#' @param nums A numeric vector
#' @return A character string
#' @export
decode_text <- function(nums) {
  if (!is.numeric(nums)) {
    stop("Input must be a numeric vector.")
  }
  valid <- ifelse(nums >= 1 & nums <= 26, nums, NA)
  output <- ifelse(is.na(valid), "?", letters[valid])
  paste0(output, collapse = "")
}

📄 Step 3: Document and Build Your Package

Use roxygen2 for inline documentation, then run:

devtools::document()
devtools::build()

🚀 Step 4: Connect to GitHub

  1. Go to: Tools > Version Control > Project Setup

  2. Initialize Git (if not already done)

  3. Then in the console:

usethis::use_github()

🚀 Step 5: Add GitHub Actions for R CMD Check

In the console, run:

usethis::use_github_action_check_standard()

This creates .github/workflows/R-CMD-check.yaml to automate package checks.

📝 Step 6: Add a LICENSE File

Use the MIT license via:

usethis::use_mit_license("Hasindu Koshitha")

✅ Step 7: CRAN-Prep Checklist

CheckCommand
Spellingspelling::spell_check_package()
Unit Testsdevtools::test()
Local R CMD Checkdevtools::check()
Windows R-devel Checkdevtools::check_win_devel()
Build PDF Manualdevtools::build_manual()
Add NEWS.mdusethis::use_news_md()

🚀 What text2numR Does

  • Converts alphabetic strings into numeric sequences (e.g., "cab" → 3 1 2)

  • Converts numeric vectors back into text (e.g., 3 1 2 → "cab")

  • Supports:

    • Case insensitivity

    • Error handling (non-letter characters)

    • Batch processing

Ready to go live on GitHub and optionally submit to CRAN!

Comments

Post a Comment

What is your thought about this?

Popular posts from this blog

Use the Google Custom Search JSON API to retrieve images

 To use the Google Custom Search JSON API to retrieve images, you need two things : ✅ 1. Google API Key 🔧 Steps: Go to the Google Cloud Console. Create a new project (or select an existing one). In the left sidebar, go to APIs & Services > Credentials . Click "Create credentials" > "API key" . Copy the API Key shown — you'll use this in your code. ✅ 2. Custom Search Engine ID (cx) 🔧 Steps: Go to the  Custom Search Engine (CSE) page. Click "Get Started" . Enter a domain to search (e.g., www.google.com or leave it as *.com to search the whole web). Click "Create" . After it's created, go to the Control Panel . Under "Search engine ID" , you'll see your cx value — copy this . 🛠 Enable Image Search: In the Custom Search Engine settings (Control Panel): Go to "Basics" > Sites to search → make sure it’s set to “Search the entire web” . Go to ...
Read more

Terminal commands relared to files in the Ubuntu

 🔍 Viewing and Navigating Files Command Description ls List files and directories in the current directory ls -l Long listing (with permissions, size, date, etc.) ls -a Show hidden files (those starting with . ) cd [directory] Change directory pwd Print current working directory tree View directory structure in tree form (may need sudo apt install tree ) 📁 Creating and Managing Files Command Description touch filename Create a new empty file nano filename Edit a file using nano text editor cat filename View file contents more filename / less filename Scroll through file contents cp file1 file2 Copy a file mv oldname newname Rename or move a file rm filename Delete a file rm -i filename Delete with confirmation rm -f filename Force delete without confirmation 📂 Working with Directories Command Description mkdir directory_name Create a directory mkdir -p path/to/directory Create nested directories rmdir directory_name Remove empty directory rm -r directory_name Remove direc...
Read more

Laravel Best Practices: Building Robust and Maintainable Applications

Image
Laravel is one of the most popular PHP frameworks due to its elegance, simplicity, and developer-friendly syntax. But to fully harness Laravel’s power, developers must adhere to certain best practices that ensure their applications are secure, maintainable, and scalable. In this article, we’ll explore typical best practices for Laravel , drawing examples from a real-world scenario—an admin system handling borrow requests. 1. Use Service Classes for Business Logic Why? Keeping your controllers thin and offloading business logic to service classes promotes separation of concerns and cleaner code. public function approveRequestAction($borrowId): JsonResponse { $this->borrowService->approve($borrowId); return response()->json(['message' => 'Request approved']); } 2. Exception Handling Graceful error handling provides better developer and user experience. Use try-catch blocks and Laravel’s built-in exceptions like ModelNotFoundException . try { $th...
Read more