https://github.com/r4ds/mentordash

https://github.com/r4ds/mentordash

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/r4ds/mentordash
• Owner: r4ds
• License: other
• Created: 2020-01-18T23:09:56.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T20:19:11.000Z (8 months ago)
• Last Synced: 2024-10-29T12:26:34.709Z (about 1 month ago)
• Language: R
• Size: 116 KB
• Stars: 9
• Watchers: 2
• Forks: 4
• Open Issues: 15
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - r4ds/mentordash - (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# mentordash

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

The goal of mentordash is to create a dashboard for mentors at the [Data Science Learning Community](https://dslc.io/).

Thank you to [yonicd](https://github.com/yonicd/threads/) for a great deal of work in the threads package!

The dashboard is now [deployed](http://dslc.io/mentordash)!

## Installation

You can install the released version of mentordash from [CRAN](https://CRAN.R-project.org) with:

``` r

# Nope.

# install.packages("mentordash")

```

And the development version from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("r4ds/mentordash")

```

## Example

```{r example, eval=FALSE}

library(mentordash)

run_app(local = TRUE)

```

## Contributing

Please note that the 'mentordash' 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.

We roughly follow the [tidyverse style guide](https://style.tidyverse.org/), with the exception that we borrow the Google convention of prefixing unexported functions with ".". For example, while golem defaults to `app_ui` for the main unexported UI function, we renamed this to `.ui_main`.