Skip to content

Commit

Permalink
update README with new badges
Browse files Browse the repository at this point in the history
  • Loading branch information
jrosen48 committed Feb 15, 2024
1 parent 841df02 commit 7cccc0b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ knitr::opts_chunk$set(
[![](https://cranlogs.r-pkg.org/badges/tidyLPA)](https://cran.r-project.org/package=tidyLPA)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00978/status.svg)](https://doi.org/10.21105/joss.00978)
[![R-CMD-check](https://github.com/data-edu/tidyLPA/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/data-edu/tidyLPA/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/data-edu/tidyLPA/graph/badge.svg?token=mNzn6tyjzS)](https://codecov.io/gh/data-edu/tidyLPA)

## Background

Expand Down
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ status](https://www.r-pkg.org/badges/version/tidyLPA)](https://cran.r-project.or
[![](https://cranlogs.r-pkg.org/badges/tidyLPA)](https://cran.r-project.org/package=tidyLPA)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00978/status.svg)](https://doi.org/10.21105/joss.00978)
[![R-CMD-check](https://github.com/data-edu/tidyLPA/workflows/R-CMD-check/badge.svg)](https://github.com/data-edu/tidyLPA/actions)
[![test-coverage](https://github.com/data-edu/tidyLPA/workflows/test-coverage/badge.svg)](https://github.com/data-edu/tidyLPA/actions)
[![R-CMD-check](https://github.com/data-edu/tidyLPA/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/data-edu/tidyLPA/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/data-edu/tidyLPA/graph/badge.svg?token=mNzn6tyjzS)](https://codecov.io/gh/data-edu/tidyLPA)

## Background

Expand Down Expand Up @@ -70,7 +70,7 @@ pisaUSA15[1:100, ] %>%
#> tidyLPA analysis using mclust:
#>
#> Model Classes AIC BIC Entropy prob_min prob_max n_min n_max BLRT_p
#> 1 3 629.72 666.20 0.80 0.84 0.95 0.04 0.67 0.01
#> 1 3 634.79 671.27 0.64 0.76 0.86 0.18 0.51 0.05
```

A simple summary of the analysis is printed to the console (and its
Expand All @@ -79,10 +79,10 @@ posterior probability).
The resulting object can be further passed down a pipeline to other
functions, such as:

- `plot_profiles()`
- `compare_solutions()`
- `get_data()`
- `get_fit()`
- `plot_profiles()`
- `compare_solutions()`
- `get_data()`
- `get_fit()`

This is the “tidy” part, in that the function can be embedded in a tidy
analysis pipeline.
Expand All @@ -104,13 +104,13 @@ pisaUSA15[1:100, ] %>%

To learn more, we highly recommend the following:

- Browse the tidyLPA [website](https://data-edu.github.io/tidyLPA/)
(especially check out the Reference page to see more about other
functions)
- *Read the Introduction to tidyLPA*
[vignette](https://data-edu.github.io/tidyLPA/articles/Introduction_to_tidyLPA.html),
which has much more information on the models that can be specified
with tidyLPA and on additional functionality
- Browse the tidyLPA [website](https://data-edu.github.io/tidyLPA/)
(especially check out the Reference page to see more about other
functions)
- *Read the Introduction to tidyLPA*
[vignette](https://data-edu.github.io/tidyLPA/articles/Introduction_to_tidyLPA.html),
which has much more information on the models that can be specified
with tidyLPA and on additional functionality

## Citing tidyLPA

Expand All @@ -126,11 +126,10 @@ One of the easiest but also most important ways to contribute is to post
a question or to provide feedback. Both positive *and* negative feedback
is welcome and helpful. You can get in touch by:

- Sending a message via <[email protected]> or view the [the
tidyLPA group page](https://groups.google.com/forum/#!forum/tidylpa)
- Sending a message via <[email protected]> or view the [the
tidyLPA group page](https://groups.google.com/forum/#!forum/tidylpa)

- Filing an issue on GitHub
[here](https://github.com/data-edu/tidyLPA)
- Filing an issue on GitHub [here](https://github.com/data-edu/tidyLPA)

Contributions are also welcome via by making pull requests (PR),
e.g. through [this page on
Expand All @@ -148,7 +147,7 @@ By participating in this project you agree to abide by its terms.
## Acknowledgments

This material is based upon work supported by the National Science
Foundation under *Grant No.: DRL\#1661064*. Any opinions, findings,
Foundation under *Grant No.: DRL#1661064*. Any opinions, findings,
conclusions, or recommendations expressed in this material are those of
the authors and do not reflect the views of the National Science
Foundation.

0 comments on commit 7cccc0b

Please sign in to comment.