{"id":13736657,"url":"https://github.com/ThinkR-open/shinipsum","last_synced_at":"2025-05-08T12:33:25.280Z","repository":{"id":56446814,"uuid":"154560209","full_name":"ThinkR-open/shinipsum","owner":"ThinkR-open","description":"Lorem-Ipsum-like Helpers for fast Shiny Prototyping","archived":false,"fork":false,"pushed_at":"2024-02-08T12:47:19.000Z","size":1409,"stargazers_count":125,"open_issues_count":8,"forks_count":7,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-06T04:19:07.683Z","etag":null,"topics":["dygraph","ggplot","golemverse","hacktoberfest","lorem-ipsum"],"latest_commit_sha":null,"homepage":"https://thinkr-open.github.io/shinipsum/","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/ThinkR-open.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-10-24T19:48:31.000Z","updated_at":"2024-09-30T10:45:45.000Z","dependencies_parsed_at":"2024-02-06T05:50:48.847Z","dependency_job_id":null,"html_url":"https://github.com/ThinkR-open/shinipsum","commit_stats":{"total_commits":41,"total_committers":5,"mean_commits":8.2,"dds":"0.46341463414634143","last_synced_commit":"36cf3a36034af3907948ebbcca8e2a00ce652a0d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fshinipsum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fshinipsum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fshinipsum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThinkR-open%2Fshinipsum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThinkR-open","download_url":"https://codeload.github.com/ThinkR-open/shinipsum/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224732129,"owners_count":17360416,"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":["dygraph","ggplot","golemverse","hacktoberfest","lorem-ipsum"],"created_at":"2024-08-03T03:01:25.900Z","updated_at":"2024-11-15T04:32:13.496Z","avatar_url":"https://github.com/ThinkR-open.png","language":"R","funding_links":[],"categories":["Developer Tools","R"],"sub_categories":["Prototyping"],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r setup, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n\u003c!-- badges: start --\u003e\n[![R build status](https://github.com/ThinkR-open/shinipsum/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/shinipsum/actions)\n[![Codecov test coverage](https://codecov.io/gh/ThinkR-open/shinipsum/branch/master/graph/badge.svg)](https://codecov.io/gh/ThinkR-open/shinipsum?branch=master)\n[![R-CMD-check](https://github.com/ThinkR-open/shinipsum/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/shinipsum/actions/workflows/R-CMD-check.yaml)\n\u003c!-- badges: end --\u003e\n\n# shinipsum \u003cimg src=\"https://raw.githubusercontent.com/ThinkR-open/shinipsum/master/img/thinkr-hex-shinipsum.png\" align=\"right\" alt=\"\" width=\"120\" /\u003e\n\nThe goal of `{shinipsum} `is to provide random shiny elements for easiest shiny app prototyping, so that you can focus on building the frontend before building the backend.\n\n\nThe full documentation can be found on the `{pkgdown} `site: \u003chttps://thinkr-open.github.io/shinipsum/\u003e\n\n## Installation\n\nYou can install the dev version of shinipsum from GitHub with:\n\n``` r\ninstall.packages(\"shinipsum\")\n```\n\n## About\n\nYou're reading the doc about version : `r pkgload::pkg_version()`\n\nThis README has been compiled on the\n\n```{r}\nSys.time()\n```\n\nHere are the test \u0026 coverage results :\n\n```{r}\ndevtools::check(quiet = TRUE)\n```\n\n```{r echo = FALSE}\nunloadNamespace(\"shinipsum\")\n```\n\n```{r}\ncovr::package_coverage()\n```\n\n\n## Demo\n\nAvailable examples:\n\n```{r}\nlibrary(shinipsum)\nipsum_examples()\n```\n\n\nYou can run `{shinipsum}` demos with:\n\n```{r eval = FALSE}\nshiny::runApp(\n  ipsum_examples(\"01_navbar.R\")\n)\n```\n\n## Available ipsums :\n\n\u003e Note: {shinipsum} only load functions which are necessary to its internal job. If you want to customise an output or to use a renderXX / XXOutput, you'll need to **explicitely** load the packages needed (for example, if you want to customise a dygraph, a ggplot, or use ggplotly).\n\n### DataTable\n\n`random_DT` takes 4 args :\n\n+ `nrow` \u0026 `ncol`: number of row and columns of the table\n+ `type` : random, numeric, character, numchar - the type of the columns\n+ `...` : args to be passed to `DT::datatable`\n\n### Image\n\n`random_image` returns a random image.\n\n### Plot\n\n`random_ggplot` takes one arg :\n\n+ `type` : Can be any of \"random\", \"point\", \"bar\", \"boxplot\",\"col\", \"tile\", \"line\", \"bin2d\", \"contour\", \"density\", \"density_2d\", \"dotplot\", \"hex\", \"freqpoly\", \"histogram\", \"ribbon\", \"raster\", \"tile\", \"violin\" and defines the geom of the ggplot. Default is \"random\", and chooses a random geom for you.\n\nDefault theme is minimal.\n\nAs the return object is a `ggplot`, it can be enhanced like any other ggplot with `+`.\n\n```{r eval = FALSE}\nlibrary(ggplot2)\nrandom_ggplot(type = \"col\") +\n  labs(title = \"Random plot\") +\n  theme_bw()\n```\n\n`random_ggplotly` calls the `ggplotly` function on a `random_ggplot`.\n\n### Dygraph\n\n`random_dygraph` returns a random dygprah. It takes one arg:\n\n+ `...`: arguments which are passed to the `dygraph()` function.\n\nAs the return object is a `dygraph`, it can be enhanced like any other dygraph.\n\n```{r eval = FALSE}\nlibrary(dygraphs)\nrandom_dygraph()  %\u003e%\n  dyRangeSelector()\n```\n\n\n### Print\n\n`random_print` takes one arg:\n\n+ `type`: can be any of `\"character\", \"numeric\", \"model\", \"table\"`, and defines the type of print. Default is `\"character\"`.\n\n\n### Table\n\n`random_table` takes three args : `nrow`, `ncols` and `type`. See `random_DT`.\n\n### Text\n\n`random_text` takes one of these two args:\n\n+ `nchar`: lorem ipsum of `nchar` characters\n+ `nwords`: lorem ipsum of `nwords` characters\n+ `offset`: number of characters or words to offset the result by\n\n### Lm\n\n`random_lm` returns a random `lm` model output:\n\n+ `nobs`: Number of observations\n+ `nx`: Number of variables (should be lower than `nobs`)\n\n\n## Example\n\nHere is an example of using `{shinipsum}` to generate a random app:\n\n```{r eval = FALSE}\nlibrary(shiny)\nlibrary(shinipsum)\nlibrary(DT)\nui \u003c- fluidPage(\n  h2(\"A Random DT\"),\n  DTOutput(\"data_table\"),\n  h2(\"A Random Image\"),\n  plotOutput(\"image\", height = \"300px\"),\n  h2(\"A Random Plot\"),\n  plotOutput(\"plot\"),\n  h2(\"A Random Print\"),\n  verbatimTextOutput(\"print\"),\n  h2(\"A Random Table\"),\n  tableOutput(\"table\"),\n  h2(\"A Random Text\"),\n  tableOutput(\"text\")\n)\n\nserver \u003c- function(input, output, session) {\n  output$data_table \u003c- DT::renderDT({\n    random_DT(10, 5)\n  })\n  output$image \u003c- renderImage({\n    random_image()\n  })\n  output$plot \u003c- renderPlot({\n    random_ggplot()\n  })\n  output$print \u003c- renderPrint({\n    random_print(\"model\")\n  })\n  output$table \u003c- renderTable({\n    random_table(10, 5)\n  })\n  output$text \u003c- renderText({\n    random_text(nwords = 50)\n  })\n}\nshinyApp(ui, server)\n\n```\n\n\u003cimg src=\"https://raw.githubusercontent.com/ThinkR-open/shinipsum/master/img/shinipsum.png\"\u003e\n\nPlease note that the 'shinipsum' project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FThinkR-open%2Fshinipsum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FThinkR-open%2Fshinipsum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FThinkR-open%2Fshinipsum/lists"}