Skip to content

Commit

Permalink
Prep for new release (#96)
Browse files Browse the repository at this point in the history
* 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
bvreede and PabRod authored Aug 22, 2024
1 parent 5413cc4 commit c7cdaf9
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
8 changes: 6 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ authors:
family-names: Dingemanse
given-names: Mark
orcid: "https://orcid.org/0000-0002-3290-5723"
-
family-names: Rodríguez-Sánchez
given-names: Pablo
orcid: 'https://orcid.org/0000-0002-2855-940X'
-
family-names: Liesenfeld
given-names: Andreas
Expand All @@ -30,6 +34,6 @@ keywords:
- conversation
- talk
- visualization
version: 0.1.0
license: Apache-2.0
version: 0.0.2
date-released: '2024-01-12'
date-released: '2024-08-22'
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

0 comments on commit c7cdaf9

Please sign in to comment.