Skip to content

Commit

Permalink
Minor improvements (#73)
Browse files Browse the repository at this point in the history
* Bump roxygen2 to latest version

* Update docs

* Update authors list

* Update .gitignore

* Ignore CITATION.cff on build

* Capitalize title field

* Lists Suggests at the end

This way the file reflects the Depends > Imports > Suggests hierarchy

* Add ifadv as a dependency

Ranks as a Suggests type dependency

* Enable GitHub action for branch 61-cran

* Perform check --as-cran

* Revert "Perform check --as-cran"

This reverts commit 5c35d9f.

* Remove devtools from description

* Update .Rbuildignore

* Update .github/workflows/R-CMD-check.yaml

* Update .gitignore
  • Loading branch information
PabRod authored Aug 20, 2024
1 parent b0bbd7f commit 1984bfa
Show file tree
Hide file tree
Showing 9 changed files with 119 additions and 59 deletions.
4 changes: 1 addition & 3 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@
^LICENSE\.md$
^\.github$
sonar.project.properties
^working_example.R

notepad.R
CITATION.cff
2 changes: 1 addition & 1 deletion .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
inst/doc
*.wav
.DS_Store
notepad.R

## Build and check files
*.tar.gz
*Rcheck
16 changes: 9 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@
Package: talkr
Type: Package
Title: Plotting conversation data
Title: Plotting Conversation Data
Version: 0.1.0
Authors@R: c(
person("Mark", "Dingemanse", email = "[email protected]", role = c("aut", "cre")),
person("Barbara", "Vreede", email = "b.vreede@esciencecenter.nl", role = "aut"),
person("Barbara", "Vreede", email = "b.vreede@gmail.com", role = "aut"),
person("Eva", "Viviani", email = "[email protected]", role = "aut"),
person("Pablo", "Rodríguez-Sánchez", email = "[email protected]", role = "aut"),
person("Andreas", "Liesenfeld", email = "[email protected]", role = "ctb"),
person("Netherlands eScience Center", role = c("cph", "fnd"))
)
Description: Functions to plot elements of conversations.
License: Apache License (>= 2)
Encoding: UTF-8
LazyData: true
Suggests:
devtools,
rmarkdown,
testthat (>= 3.0.0)
VignetteBuilder: knitr
RoxygenNote: 7.2.3
RoxygenNote: 7.3.2
Depends:
R (>= 3.5.0)
Imports:
Expand All @@ -35,4 +32,9 @@ Imports:
tidyselect,
tibble,
viridis
Suggests:
rmarkdown,
testthat (>= 3.0.0),
ifadv
Remotes: git::https://github.com/elpaco-escience/ifadv.git
Config/testthat/edition: 3
63 changes: 51 additions & 12 deletions man/geom_token.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

63 changes: 51 additions & 12 deletions man/geom_turn.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 0 additions & 8 deletions tests/testthat/test-inspect_language.R
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
## set up the test environment
# Install ifadv and devtools only if required
if (!requireNamespace("ifadv")){
if (!requireNamespace("devtools")){
install.packages("devtools")
}
devtools::install_github("elpaco-escience/ifadv")
}

data <- ifadv::ifadv

test_that("language inspection yields stats", {
Expand Down
8 changes: 0 additions & 8 deletions tests/testthat/test-report.R
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
## set up the test environment
# Install ifadv and devtools only if required
if (!requireNamespace("ifadv")){
if (!requireNamespace("devtools")){
install.packages("devtools")
}
devtools::install_github("elpaco-escience/ifadv")
}

data <- ifadv::ifadv

test_that("summary reports are accurate", {
Expand Down
9 changes: 2 additions & 7 deletions vignettes/workflow.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,9 @@ library(talkr)
## Data

We will be using the IFADV corpus as example data for the workflow of `talkr`.
A prepared dataset can be downloaded by installing the `ifadv` package:
The snippet below initializes the talkr dataset using the ifadv data.

```{r install data package}
# install.packages("devtools")
devtools::install_github("elpaco-escience/ifadv")
```

We will initialize the talkr dataset using the ifadv data, as follows:
For more information about the IFADV dataset, see the [repository link](https://github.com/elpaco-escience/ifadv).

```{r}
data <- init(ifadv::ifadv)
Expand Down

0 comments on commit 1984bfa

Please sign in to comment.