-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
70 lines (49 loc) · 1.56 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# pockethostr
<!-- badges: start -->
<!-- badges: end -->
**WORK in PROGRESS** and subject to change.
This is a very early attempt to wrap the EUROCONTROL Data API from [PoketHost][ph] in R.
It will probably result in a more low-level generic package to support [PocketBase][pb]/PocketHost
and a package specific for the EUROCONTROL Data App.
[ph]: <https://pockethost.io/> "PocketHost - Amazingly Simple PocketBase Hosting"
[pb]: <https://pocketbase.io/> "PocketBase - Open Source backend for your next SaaS and Mobile app
in 1 file"
## Installation
You can install the development version of `pockethostr` from [GitHub](https://github.com/) with:
``` r
# install.packages("pak")
pak::pkg_install("euctrl-pru/pockethostr")
```
## Example
List all records in the EUROCONTROL Data app:
```{r list-all-records, eval=FALSE}
library(pockethostr)
app <- "eurocontrol-data-test"
collection <- "nw_traffic"
ph_list_records(
app = "eurocontrol-data-test",
api = "/api/collections/",
collection = "nw_traffic",
sort = "-FLIGHT_DATE")
```
# Development
In order to build the relevant pkgdown web pages, execute the following code:
```{r pkgdown-cuild, eval=FALSE}
# How to build the pakgdown from behind proxied Internet
library(withr)
library(pkgdown)
with_options(list(pkgdown.internet = FALSE),
build_site())
```