{"id":13697299,"url":"https://github.com/cschwem2er/stminsights","last_synced_at":"2025-04-09T14:11:20.447Z","repository":{"id":47800106,"uuid":"63054187","full_name":"cschwem2er/stminsights","owner":"cschwem2er","description":"A Shiny Application for Inspecting Structural Topic Models","archived":false,"fork":false,"pushed_at":"2024-06-27T01:33:09.000Z","size":20046,"stargazers_count":117,"open_issues_count":2,"forks_count":16,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-02T11:03:22.180Z","etag":null,"topics":["natural-language-processing","r","shiny","topic-modeling"],"latest_commit_sha":null,"homepage":"https://cschwem2er.github.io/stminsights","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cschwem2er.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-11T09:19:27.000Z","updated_at":"2025-03-12T09:18:28.000Z","dependencies_parsed_at":"2022-08-21T05:50:11.424Z","dependency_job_id":"df03c0b5-db19-4ea3-b963-6a8944552ba4","html_url":"https://github.com/cschwem2er/stminsights","commit_stats":{"total_commits":123,"total_committers":4,"mean_commits":30.75,"dds":0.4065040650406504,"last_synced_commit":"d6698bf35a157895160ad0a1cf1b0442fb7d5ca5"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cschwem2er%2Fstminsights","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cschwem2er%2Fstminsights/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cschwem2er%2Fstminsights/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cschwem2er%2Fstminsights/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cschwem2er","download_url":"https://codeload.github.com/cschwem2er/stminsights/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248054196,"owners_count":21039952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["natural-language-processing","r","shiny","topic-modeling"],"created_at":"2024-08-02T18:00:55.364Z","updated_at":"2025-04-09T14:11:20.410Z","avatar_url":"https://github.com/cschwem2er.png","language":"R","funding_links":[],"categories":["Visualizations","R"],"sub_categories":["Embedding based Topic Models"],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\n# stminsights\n\n\n[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/cschwem2er/stminsights?branch=master\u0026svg=true)](https://ci.appveyor.com/project/cschwem2er/stminsights)\n[![CRAN status](https://www.r-pkg.org/badges/version/stminsights)](https://cran.r-project.org/package=stminsights)\n[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/stminsights)](https://cran.r-project.org/package=stminsights)\n\n\n```{r, include = FALSE}\n#[![CRAN status](https://www.r-pkg.org/badges/version/stminsights)](https://cran.r-project.org/package=stminsights)\n#[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/stminsights)](https://cran.rstudio.com/web/packages/stminsights/index.html)\n```\n\n\n\n\u003cimg src=\"man/figures/logo.png\" width=\"800\"\u003e\n\n## A Shiny Application for Structural Topic Models\n\nThis app enables interactive validation, interpretation and visualization of [Structural Topic Models](https://www.structuraltopicmodel.com/) (STM).  Stminsights is focused on making your life easier after fitting your STM models. In case you are not familiar with the STM [package](https://CRAN.R-project.org/package=stm), the corresponding vignette is an excellent starting point.\n\n## How to Install\n\nYou can download and install the latest development version of stminsights by running ``devtools::install_github('cschwem2er/stminsights')``.    \n\nFor Windows users installing from github requires proper setup of [Rtools](https://cran.r-project.org/bin/windows/Rtools/).\n\nstminsights can also be installed from CRAN by running ``install.packages('stminsights')``.\n\n## How to Use\n\nAfter loading stminsights you can launch the shiny app in your browser:\n\n\n```{r, eval = FALSE}\nlibrary(stminsights)\nrun_stminsights()\n```\n\nYou can then upload a `.RData` file which should include:\n\n  - one or several `stm` objects.\n  - one or several `estimateEffect` objects.\n  - an object `out` which was used to fit your stm models.\n\nAs an example, the following code fits two models and estimates effects for the Political Blog Corpus. Afterwards, all objects required for stminsights are stored in `stm_poliblog5k.RData`. \n\n\n```{r, eval = FALSE}\nlibrary(stm)\n\nout \u003c- list(documents = poliblog5k.docs,\n            vocab = poliblog5k.voc,\n            meta = poliblog5k.meta)\n\npoli \u003c- stm(documents = out$documents, \n            vocab = out$vocab,\n            data = out$meta, \n            prevalence = ~ rating * s(day),\n            K = 20)\nprep_poli \u003c- estimateEffect(1:20 ~ rating * s(day), poli,\n                            meta = out$meta)\n\npoli_content \u003c-  stm(documents = out$documents, \n                     vocab = out$vocab,\n                     data = out$meta, \n                     prevalence = ~ rating + s(day),\n                     content = ~ rating,\n                     K = 15)  \nprep_poli_content \u003c- estimateEffect(1:15 ~ rating + s(day), poli_content,\n                                    meta = out$meta)\n\nsave.image('stm_poliblog5k.RData')\n```\n\n\nAfter launching stminsights and uploading the file, all objects are automatically imported and you can select which models and effect estimates to analyze.\n\nIn addition to the shiny app, several helper functions are available, e.g. ``get_effects()`` for storing effect estimates in a tidy dataframe.\n\n## How to Deploy on Shiny Server\n\nTo deploy stminsights to your own shiny server, place the file `app.R`, which is located at `inst/app` of this package, to a folder in your server directory and you should be good to go.\n\n## Citation\n\nPlease cite stminsights if you use it for your publications:\n\n```\n  Carsten Schwemmer (2024). stminsights: A Shiny Application for Inspecting\n  Structural Topic Models. R package version 0.4.3.\n  https://github.com/cschwem2er/stminsights\n```\n\nA BibTeX entry for LaTeX users is:\n\n```\n  @Manual{,\n    title = {stminsights: A Shiny Application for Inspecting Structural Topic Models},\n    author = {Carsten Schwemmer},\n    year = {2024},\n    note = {R package version 0.4.3},\n    url = {https://github.com/cschwem2er/stminsights},\n  }\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcschwem2er%2Fstminsights","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcschwem2er%2Fstminsights","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcschwem2er%2Fstminsights/lists"}