-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
94 lines (59 loc) · 4 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
91
92
93
94
---
title: "YDisk4R -- набор R функций для работы с Yandex Disk"
author: "Лутай А.В."
output:
github_document:
toc: yes
toc_depth: 4
date: '2024-07-13'
---
### Установка
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
devtools::install_github("alexeilutay/YDisk4R")
```
### Перечень функций
Перед началом работы рекомендуется [получить Yandex OAuth](https://yandex.ru/dev/id/doc/ru/register-client) и принять решение о том, где он будет храниться на компьютере.
Приведенные ниже примеры описывают не все возможности функций.
**Хранение в Renviron**
Этот способ считается недостаточно безопасным (файл .Renviron хранится в домашней директории компьютера в виде текстового файла), тем не менее этот способ достаточно популярен.
- открыть file.edit("~/.Renviron")
- записать полученный токен в строке вида YDisk=OAuth y0_......
- сохранить файл "~/.Renviron"
Примечание: не забудьте о переносе строки в конце списка файла Renviron.
**set_YD_oath**
Функция сначала ищет значение YDisk в Global Environment. Если не находит YDisk, тогда ищет иную переменную, значение которой начинается OAuth y0_...
Функция возвращает найденное значение, которое затем можно использовать в качестве токена для обращения к Yandex Disk.
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
yd_oauth <- set_YD_oath()
```
***
**get_YD_folders**
Возвращает список папок по указанному пути и все их свойства. По умолчанию, path - корневая папка Yandex Disk, limit = 100.
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
get_YD_folders(path = "disk:/Загрузки/", token = yd_oauth)
```
***
**get_YD_files**
Возвращает список файлов по указанному пути и все их свойства. Для иллюстраций Yandex предоставляет набор URL, используя которые можно скачать копии различных размеров. В возвращемой таблице все эти ссылки слиты в одну ячейку по шаблону {format}
По умолчанию, path - корневая папка Yandex Disk, а limit = 100.
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
get_YD_files(path = "disk:/Загрузки/", token = set_YD_oauth(), limit = 10)
```
***
**upload_file_2YD**
Загружает файл в указанную папку Yandex Disk.
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
upload_file_2YD(path = "disk:/Загрузки/",
disk_fname = "../../bookmarks.html",
overwrite = TRUE, token = yd_oauth)
```
Выводит статус загрузки -- если видите 201, значит файл на месте.
**my_public_files**
Возвращает полный список public-файлов со всеми деталями в виде dataframe.
```{r echo=TRUE, eval = FALSE, message=FALSE, warning=FALSE}
my_public_files(limit = 100, token = set_YD_oauth())
```
## Обратная связь
Пакет сделан для моего личного использования, у меня нет планов доведения пакета до CRAN статуса.
Если желаете развивать, код открыт.
Если сделаете pull request, постараюсь принять.