Skip to content

Commit

Permalink
Rename dataset_ to entitylist_
Browse files Browse the repository at this point in the history
* Add naming conventions to contributing guide
* Add NEWS
* Update README attribution
* Replace any reference to `dataset_` with `entitylist_`
* Lint and style package
* Fix `semver_{gt, lt}` examples: takes plain version string, not parsed semver object
  • Loading branch information
florianm committed Mar 15, 2024
1 parent a940692 commit dc2c8d8
Show file tree
Hide file tree
Showing 26 changed files with 554 additions and 513 deletions.
29 changes: 22 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,41 @@ Git and GitHub.
For more general info about contributing to `ruODK`, see the
[Resources](#resources) at the end of this document.

### Naming conventions
ruODK names functions after ODK Central endpoints. If there are aliases, such as
"Dataset" and "Entity List", choose the alias that is shown to Central users
(here, choose "Entity List") over internally used terms.

Function names combine the object name (`project`, `form`, `submission`,
`attachment`, `entitylist`, `entity`, etc.) with the action (`list`, `detail`,
`patch`) as snake case, e.g. `project_list()`.
In case of any uncertainty, discussion is welcome.

In contrast, `pyODK` uses a class based approach with the pluralised object name
separated from the action `client.entity_lists.list()`.

Documentation should capitalise ODK Central object names: Project, Form,
Submission, Entity.

### Prerequisites
To test the package, you will need valid credentials for the ODK Central instance
used as a test server.
Create an [account request issue](https://github.com/ropensci/ruODK/issues/new/choose).
To test the package, you will need valid credentials for an existing ODK Central
instance to be used as a test server.

Before you do a pull request, you should always file an issue and make sure
the maintainers agree that it is a problem, and is happy with your basic proposal
for fixing it.
If you have found a bug, follow the issue template to create a minimal
[reprex](https://www.tidyverse.org/help/#reprex).
[reprex](https://www.tidyverse.org/help/#reprex) if you can do so without
revealing sensitive information. Never include credentials in your reprex.

### Checklists
Some changes have intricate internal and external dependencies, which are easy
to miss and break. These checklists aim to avoid these pitfalls.

Test and update reverse dependencies (wastdr, etlTurtleNesting, etc.).

#### Adding a dependency
* Update DESCRIPTION
* Update GH Actions install workflows - do R package deps have system deps? Can GHA install them in all environments?
* Update GH Actions install workflows - do R package deps have system deps?
Can GHA install them in all environments?
* Update Dockerfile
* Update binder install.R
* Update installation instructions
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: ruODK
Title: An R Client for the ODK Central API
Version: 1.5.0.9000
Version: 1.4.9.9001
Authors@R:
c(person(given = c("Florian", "W."),
family = "Mayer",
Expand Down
6 changes: 3 additions & 3 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ export(attachment_get)
export(attachment_link)
export(attachment_list)
export(audit_get)
export(dataset_detail)
export(dataset_list)
export(dataset_update)
export(drop_null_coords)
export(encryption_key_list)
export(enexpr)
export(enquo)
export(ensym)
export(entitylist_detail)
export(entitylist_list)
export(entitylist_update)
export(expr)
export(exprs)
export(form_detail)
Expand Down
10 changes: 7 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# ruODK 1.5.0
## Major changes
* Support Entities and Entity Lists (Datasets) (#152)

# ruODK 1.4.2
This release migrates the `ruODK` test suite to a new test server
`ruodk.getodk.cloud` which was generously sponsored by GetODK.
Expand All @@ -16,9 +20,9 @@ This release fixes a few compatibility issues and bumps dependencies to R (4.1)
and imported/suggested packages.
Upgrade carefully and revert to 1.3.12 if things go awry.

* Update to new tidyselect syntax: Using vectors of names to select makes
tidyselect complain (WARN, soon ERROR). We wrap all programmatic selections of
variable names in `dplyr::all_of()` where we expect a single variable to be
* Update to new `tidyselect` syntax: Using vectors of names to select makes
`tidyselect` complain (WARN, soon ERROR). We wrap all programmatic selections
of variable names in `dplyr::all_of()` where we expect a single variable to be
selected, and `dplyr::any_of()` where we select using fuzzy matching
(e.g. `dplyr::starts_with()`). (#146)
* Make `ruODK::form_list()` robust against `reviewState` missing from outdated
Expand Down
84 changes: 0 additions & 84 deletions R/dataset_detail.R

This file was deleted.

82 changes: 0 additions & 82 deletions R/dataset_list.R

This file was deleted.

108 changes: 0 additions & 108 deletions R/dataset_update.R

This file was deleted.

Loading

0 comments on commit dc2c8d8

Please sign in to comment.