Skip to content

Commit c7cdaf9

Browse files
bvreedePabRod
andauthored
Prep for new release (#96)
* 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]>
1 parent 5413cc4 commit c7cdaf9

File tree

2 files changed

+29
-12
lines changed

2 files changed

+29
-12
lines changed

CITATION.cff

+6-2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ authors:
1313
family-names: Dingemanse
1414
given-names: Mark
1515
orcid: "https://orcid.org/0000-0002-3290-5723"
16+
-
17+
family-names: Rodríguez-Sánchez
18+
given-names: Pablo
19+
orcid: 'https://orcid.org/0000-0002-2855-940X'
1620
-
1721
family-names: Liesenfeld
1822
given-names: Andreas
@@ -30,6 +34,6 @@ keywords:
3034
- conversation
3135
- talk
3236
- visualization
37+
version: 0.1.0
3338
license: Apache-2.0
34-
version: 0.0.2
35-
date-released: '2024-01-12'
39+
date-released: '2024-08-22'

README.md

+23-10
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22
# talkr
33

44
<!-- badges: start -->
5+
[![CRAN status](https://www.r-pkg.org/badges/version/talkr)](https://cran.r-project.org/package=talkr)
6+
[![github license badge](https://img.shields.io/github/license/elpaco-escience/talkr)]([email protected]:elpaco-escience/talkr)
57
[![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)
8+
[![documentation badge](https://img.shields.io/badge/pkgdown-documentation-khaki)](https://elpaco-escience.github.io/talkr/)
9+
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
610
<!-- badges: end -->
711

8-
## Note
12+
`talkr` offers a set of convenience functions for quality control, visualisation and analysis of conversational data.
13+
It provides support for at least two common needs of people working with conversational corpora:
14+
(1) quality control by offering rapid insights into the nature, timing, and quality of time-aligned annotations in a conversational corpus; and
15+
(2) compelling visualisations by offering a range of plotting functions that play well with ggplot and the tidyverse.
916

10-
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.
11-
12-
## Overview
13-
14-
{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.
15-
16-
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.
17+
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.
1718

1819
## Installation
1920

@@ -24,12 +25,24 @@ You can install the development version of `talkr` from GitHub with:
2425
devtools::install_github("elpaco-escience/talkr", build_vignettes = TRUE)
2526
```
2627

28+
`talkr` has been submitted to CRAN, and will soon be installable with:
29+
```r
30+
install.packages("talkr")
31+
```
32+
2733
## Workflow
2834

29-
The main workflow for `talkr` is described in the workflow vignette.
30-
You can access the vignette by running:
35+
The main workflow for `talkr` is described in [the workflow vignette](https://elpaco-escience.github.io/talkr/articles/workflow.html).
36+
37+
38+
You can also access the vignette from RStudio, by running:
3139

3240
``` r
3341
vignette("workflow", package = "talkr")
3442
```
3543

44+
## Contact
45+
46+
Questions? Comments? They are more than welcome!
47+
This package is under active development and still has some rough edges.
48+
Interact with us in the [issues](https://github.com/elpaco-escience/talkr/issues) if you have any questions or suggestions.

0 commit comments

Comments
 (0)