-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
executable file
·90 lines (53 loc) · 2.62 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
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/",
out.width = "100%"
)
```
radiofrance <img src="https://raw.githubusercontent.com/ahasverus/mystickers/master/pngs/radiofrance.png" height="120px" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/ahasverus/radiofrance/actions/workflows/R-CMD-check.yaml)
[](https://github.com/ahasverus/radiofrance/actions/workflows/pkgdown.yaml)
[](https://github.com/ahasverus/radiofrance/actions/workflows/update-podcasts.yml)
[](https://choosealicense.com/licenses/mit/)
<!-- badges: end -->
The goal of the R package `radiofrance` is to retrieve Radio France
(France Inter, France Culture, etc.) podcasts metadata (date, title, mp3 URL and
and duration). User can easily download metadata for any podcast. The name of
the podcast must be extracted from the website URL (e.g. Le Moment Meurice must
be written as `le-moment-meurice`).
## Installation
You can install the development version from [GitHub](https://github.com/) with:
```{r eval = FALSE}
remotes::install_github("ahasverus/radiofrance")
```
Then you can attach the package `radiofrance`:
```{r eval = FALSE}
library("radiofrance")
```
## Usage
```{r eval=FALSE}
podcast_name <- "la-chronique-de-waly-dia"
## Retrieve episodes information ----
tab <- get_metadata(podcast_name, radio = "franceinter")
## Create a M3U playlist ----
create_m3u(tab, podcast_name)
```
The `m3u` file can be open with [VLC](https://www.videolan.org/vlc/index.en.html)
to stream all episodes. To retrieve new episodes, just re-run the functions
`get_metadata()` and `create_m3u()`.
## Citation
Please cite this package as:
> Casajus N (`r format(Sys.Date(), "%Y")`) radiofrance: An R package to retrieve
Radio France podcasts metadata. R package version 1.0.
## Code of Conduct
Please note that the `radiofrance` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.