The goal of BertopicR is to allow R users to access bertopic’s topic modelling suite in R via Reticulate. Bertopic was written and developed by Maarten Grootendorst (and other contributors!).
The package does not aim to implement every feature of bertopic, and is designed with specific end users in mind who may not be experienced programmers or developers. You may submit issues for feature requests; however, it may be faster to go direct to the original, Python library which has excellent documentation. [BERTopic documentation]
We have tried to stay true to the Python library, whilst developing a
package which has an ‘R feel’ i.e. uses functions more than OOP. In
places we have changed the names of arguments, for example in the Python
library BERTopic() takes hdbscan_model = x, but we have opted for
clustering_model = x. The reason for this is that hdbscan_model = is
an artifact from the early days of bertopic and the author wants to
ensure code is backwards compatible, but if the package were being
developed now it’s likely the author would opt for clustering_model =.
There are other such changes to be aware of.
The package currently installs an exact version of bertopic - 0.15.0, features introduced after this version will take time to, or may never, reach this package.
Before installing bertopic make sure that you have miniconda installed, if you don’t:
library(reticulate) #install.packages("reticulate") if you don't have this already or aren't sure how to install.
reticulate::install_miniconda()Once you have reticulate and miniconda installed, you can then install the development version of BertopicR from GitHub with:
# install.packages("devtools")
devtools::install_github("jpcompartir/BertopicR")
library(BertopicR)
#Check your environment has been loaded correctly and bertopic has been installed:
BertopicR::check_python_dependencies()If you receive the message: “bertopic not in installed packages of current environment…” run:
BertopicR::install_python_dependencies()BertopicR ships with a dataset of unstructured text data
bert_example_data
data <- BertopicR::bert_example_data
embedder <- bt_make_embedder("all-minilm-l6-v2")
embeddings <- bt_do_embedding(embedder, documents = data$message, batch_size = 16L)
#>
#> Embedding proccess finished
#> all-minilm-l6-v2 added to embeddings attributes
reducer <- bt_make_reducer_umap(n_neighbours = 10L, n_components = 10L, metric = "cosine")
clusterer <- bt_make_clusterer_hdbscan(min_cluster_size = 20L, metric = "euclidean", cluster_selection_method = "eom", min_samples = 10L)
topic_model <- bt_compile_model(embedding_model = embedder,
reduction_model = reducer,
clustering_model = clusterer)
#>
#> No vectorising model provided, creating model with default parameters
#>
#> No ctfidf model provided, creating model with default parameters
#>
#> Model built
#Fit the model
fitted_model <- bt_fit_model(model = topic_model,
documents = data$message,
embeddings = embeddings)
#> UMAP(angular_rp_forest=True, low_memory=False, metric='cosine', min_dist=0.0, n_components=10, n_neighbors=10, random_state=42, verbose=True)
#> Fri Sep 15 12:58:15 2023 Construct fuzzy simplicial set
#> Fri Sep 15 12:58:27 2023 Finding Nearest Neighbors
#> Fri Sep 15 12:58:29 2023 Finished Nearest Neighbor Search
#> Fri Sep 15 12:58:31 2023 Construct embedding
#> Fri Sep 15 12:58:37 2023 Finished embedding
fitted_model$get_topic_info() %>%
dplyr::tibble()
#> # A tibble: 36 × 5
#> Topic Count Name Representation Representative_Docs
#> <dbl> <dbl> <chr> <list> <list>
#> 1 -1 1750 -1_hispanicheritagemonth_mont… <chr [10]> <chr [3]>
#> 2 0 278 0_beto_trump_vote_fake <chr [10]> <chr [3]>
#> 3 1 238 1_night_heritage night_herita… <chr [10]> <chr [3]>
#> 4 2 168 2_dance_salsa_music_tito <chr [10]> <chr [3]>
#> 5 3 150 3_heritage month_month_octobe… <chr [10]> <chr [3]>
#> 6 4 126 4_students_school_grade_proje… <chr [10]> <chr [3]>
#> 7 5 109 5_latinx_latina_uber_latinas <chr [10]> <chr [3]>
#> 8 6 94 6_mdcps_mdcpscentral_celebrat… <chr [10]> <chr [3]>
#> 9 7 90 7_good thread_thread_yup_yes <chr [10]> <chr [3]>
#> 10 8 90 8_hispanicheritagemonth hispa… <chr [10]> <chr [3]>
#> # ℹ 26 more rowsWe have tried to provide informative error messages but sometimes you may be faced with error messages that have arisen from the parent python function used. If you get an error that begins with “Error in py_call_impl(callable, call_args$unnamed, call_args$named) :”, you can use reticulate::py_last_error() to trace the origin of the error message.
Note that one common cause of error messages when working with python functions in R arises when the user fails to specify integer numbers as integer type. In R, integers are of type “numeric” by default, python functions typically require them to be explicitly specified as integer type. For any formal function arguments, this conversion is dealt with within in the function, however you should be aware of this if specifying extra arguments to any function. In R, this is achieved by placing an L after the number or using the as.integer() function:
# numbers default to "numeric"
class(4)
#> [1] "numeric"
# we can force them to be "integer"
class(4L)
#> [1] "integer"
class(as.integer(4))
#> [1] "integer"