Skip to content

Commit

Permalink
v1.3.0 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Mayer authored and Florian Mayer committed Oct 10, 2021
1 parent 1709b50 commit dafa2b9
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 7 deletions.
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.2.0.0002
Version: 1.3.0
Authors@R:
c(person(given = c("Florian", "W."),
family = "Mayer",
Expand Down
21 changes: 21 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# `ruODK` 1.3.0
This release supports ODK Central 1.3.0 and represents an over-due version
bump to reflect the supported ODK Central version.
The test server is now updated to ODK Central 1.3.0, and all tests pass.

There are still some newer and as yet unsupported API endpoints in ODK Central,
which serve administrative purposes of the front-end. Contributions are welcome,
get started on [these issues](https://github.com/ropensci/ruODK/milestone/2)
and the contributing guide. As ruODK focuses on data retrieval, these
administrative endpoints are non-critical to ruODK's purpose.

## Major fixes
## Minor fixes
## Documentation
## Data
* Packaged data has been re-created to represent the latest server outputs.
## Maintenance
* All tests pass, GitHub Actions is as per usual brittle at the installation
step.


# `ruODK` 1.2.0.0000
We are shaping up to a release targetting the ODK Central 1.2 release.
ODK Central is undergoing some bug fixes and patches, while ruODK's test server
Expand Down
13 changes: 11 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -139,20 +139,29 @@ Alternatively, you can install the development version from the `main` branch.

```{r gh-installation, eval = FALSE}
if (!requireNamespace("remotes")) install.packages("remotes")
# Full install
remotes::install_github(
"ropensci/ruODK@main",
dependencies = TRUE,
upgrade = "always",
build_vignettes = TRUE)
# Minimal install without vignettes
remotes::install_github(
"ropensci/ruODK@main",
dependencies = TRUE,
upgrade = "ask",
build_vignettes = FALSE)
```

If the install fails, read the error messages carefully and install any unmet
dependency (system libraries or R packages).
dependencies (system libraries or R packages).

If the install fails on building the vignettes, you can set
`build_vignettes=FALSE` and read the vignettes from the online docs instead.

If the installation still fails, feel free to submit a [bug report](https://github.com/ropensci/ruODK/issues/new/choose).
If the installation still fails, or the above does not make any sense,
feel free to submit a [bug report](https://github.com/ropensci/ruODK/issues/new/choose).

## ODK Central
### Access to an ODK Central instance
Expand Down
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,21 +150,30 @@ branch.

``` r
if (!requireNamespace("remotes")) install.packages("remotes")
# Full install
remotes::install_github(
"ropensci/ruODK@main",
dependencies = TRUE,
upgrade = "always",
build_vignettes = TRUE)

# Minimal install without vignettes
remotes::install_github(
"ropensci/ruODK@main",
dependencies = TRUE,
upgrade = "ask",
build_vignettes = FALSE)
```

If the install fails, read the error messages carefully and install any
unmet dependency (system libraries or R packages).
unmet dependencies (system libraries or R packages).

If the install fails on building the vignettes, you can set
`build_vignettes=FALSE` and read the vignettes from the online docs
instead.

If the installation still fails, feel free to submit a [bug
If the installation still fails, or the above does not make any sense,
feel free to submit a [bug
report](https://github.com/ropensci/ruODK/issues/new/choose).

## ODK Central
Expand Down Expand Up @@ -251,15 +260,15 @@ citation("ruODK")
#> To cite ruODK in publications use (with the respective version number:
#>
#> Mayer, Florian Wendelin. (2020, Nov 19). ruODK: An R Client for the
#> ODK Central API (Version 0.10.1). Zenodo.
#> ODK Central API (Version X.X.X). Zenodo.
#> https://doi.org/10.5281/zenodo.3953158
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Misc{,
#> title = {ruODK: Client for the ODK Central API},
#> author = {Florian W. Mayer},
#> note = {R package version 0.10.1},
#> note = {R package version X.X.X},
#> year = {2020},
#> url = {https://github.com/ropensci/ruODK},
#> }
Expand Down

0 comments on commit dafa2b9

Please sign in to comment.