-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update version number and release date on Citation.CFF * talkr is no longer just under development * add badges * add CRAN badge * documentation badge in different color * remove header * Add Pablo to CITATION --------- Co-authored-by: Pablo Rodríguez Sánchez <[email protected]>
- Loading branch information
Showing
2 changed files
with
29 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,18 +2,19 @@ | |
# talkr | ||
|
||
<!-- badges: start --> | ||
[![CRAN status](https://www.r-pkg.org/badges/version/talkr)](https://cran.r-project.org/package=talkr) | ||
[![github license badge](https://img.shields.io/github/license/elpaco-escience/talkr)]([email protected]:elpaco-escience/talkr) | ||
[![R-CMD-check](https://github.com/elpaco-escience/talkr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/elpaco-escience/talkr/actions/workflows/R-CMD-check.yaml) [![codecov](https://codecov.io/github/elpaco-escience/talkr/graph/badge.svg?token=MTA2S1LLGH)](https://codecov.io/github/elpaco-escience/talkr) | ||
[![documentation badge](https://img.shields.io/badge/pkgdown-documentation-khaki)](https://elpaco-escience.github.io/talkr/) | ||
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing) | ||
<!-- badges: end --> | ||
|
||
## Note | ||
`talkr` offers a set of convenience functions for quality control, visualisation and analysis of conversational data. | ||
It provides support for at least two common needs of people working with conversational corpora: | ||
(1) quality control by offering rapid insights into the nature, timing, and quality of time-aligned annotations in a conversational corpus; and | ||
(2) compelling visualisations by offering a range of plotting functions that play well with ggplot and the tidyverse. | ||
|
||
This package is under active development and still has some rough edges. Interact with us in the [issues](https://github.com/elpaco-escience/talkr/issues) if you have any questions or suggestions. | ||
|
||
## Overview | ||
|
||
{talkr} offers a set of convenience functions for quality control, visualisation and analysis of conversational data. It provides support for at least two common needs of people working with conversational corpora: (1) quality control by offering rapid insights into the nature, timing, and quality of time-aligned annotations in a conversational corpus; and (2) compelling visualisations by offering a range of plotting functions that play well with ggplot and the tidyverse. | ||
|
||
Note: {talkr} plays well with its companion python package [`scikit-talk`](https://github.com/elpaco-escience/scikit-talk), which is focused more on processing conversational data and readying it for downstream analysis. | ||
Note: `talkr` plays well with its companion python package [`scikit-talk`](https://github.com/elpaco-escience/scikit-talk), which is focused more on processing conversational data and readying it for downstream analysis. | ||
|
||
## Installation | ||
|
||
|
@@ -24,12 +25,24 @@ You can install the development version of `talkr` from GitHub with: | |
devtools::install_github("elpaco-escience/talkr", build_vignettes = TRUE) | ||
``` | ||
|
||
`talkr` has been submitted to CRAN, and will soon be installable with: | ||
```r | ||
install.packages("talkr") | ||
``` | ||
|
||
## Workflow | ||
|
||
The main workflow for `talkr` is described in the workflow vignette. | ||
You can access the vignette by running: | ||
The main workflow for `talkr` is described in [the workflow vignette](https://elpaco-escience.github.io/talkr/articles/workflow.html). | ||
|
||
|
||
You can also access the vignette from RStudio, by running: | ||
|
||
``` r | ||
vignette("workflow", package = "talkr") | ||
``` | ||
|
||
## Contact | ||
|
||
Questions? Comments? They are more than welcome! | ||
This package is under active development and still has some rough edges. | ||
Interact with us in the [issues](https://github.com/elpaco-escience/talkr/issues) if you have any questions or suggestions. |