Introduction to quickSentiment"

In quickSentiment: A Fast and Flexible Pipeline for Text Classification

--- 1. SETUP: LOAD LIBRARIES ---

-------------------------------------------------------------------

library(quickSentiment)

library(doParallel)
# CRAN limits the number of cores used during package checks
cores <- min(2, parallel::detectCores())
registerDoParallel(cores = cores)

--- 2. LOAD AND PREPARE TRAINING DATA ---

# Look for the file in the installed package first
csv_path <- system.file("extdata", "tweets.csv", package = "quickSentiment")

# Fallback for when you are building the package locally
if (csv_path == "") {
  csv_path <- "../inst/extdata/tweets.csv"
}
tweets <- read.csv(csv_path)
set.seed(123)

--- 3. PREPROCESS THE TEXT ---

-------------------------------------------------------------------

Use the pre_process() function from our package to clean the raw text.

This step is done externally to the main pipeline, allowing you to reuse

the same cleaned text for multiple different models or analyses in the future.

tweets$cleaned_text <- pre_process(tweets$Tweet)
tweets$sentiment = ifelse(tweets$Avg>0,'P','N')

--- 4. RUN THE MAIN TRAINING PIPELINE ---

-------------------------------------------------------------------

This is the core of the package. We call the main pipeline() function

to handle the train/test split, vectorization, model training, and evaluation.

result <- pipeline(
  # --- Define the vectorization method ---
  # Options: "bow" (raw counts), "tf" (term frequency), "tfidf", "binary"
  vect_method = "tf",

  # --- Define the model to train ---
  # Options: "logit", "rf", "xgb","nb"
  model_name = "rf",

  # --- Specify the data and column names ---
  text_vector = tweets$cleaned_text  ,   # The column with our preprocessed text
  sentiment_vector = tweets$sentiment,    # The column with the target variable

  # --- Set vectorization options ---
  # Use n_gram = 2 for unigrams + bigrams, or 1 for just unigrams
  #these are optional parameters
  balance = TRUE,
  n_gram = 1,
  parallel = cores
)

===================================================================

--- 5. EVALUATE THE RESULTS

===================================================================

Get the AUC, ROC and Accuracy at Decile Threshold

evaluate_result<- evaluate_performance(result$probs[,2],result$y_test,"P")
evaluate_result

plot(evaluate_result$roc)

plot(evaluate_result$prc)

===================================================================

--- 6. PREDICTION ON NEW, UNSEEN DATA ---

===================================================================

The training is complete. The 'result' object now contains our trained

model and all the necessary "artifacts" for prediction.

predicted_tweets <- predict_sentiment(
  pipeline_object = result,
  tweets$cleaned_text
)
head(predicted_tweets)

quickSentiment documentation built on Aug. 29, 2026, 1:07 a.m.