README.md 12 KB
Newer Older
1
2
3
4
5
6
[//]: # "#to make links in gitlab: example with racon https://github.com/isovic/racon"
[//]: # "tricks in markdown: https://openclassrooms.com/fr/courses/1304236-redigez-en-markdown"

| usage | R dependencies |
| --- | --- |
| [![R Version](https://img.shields.io/badge/code-R-blue?style=plastic)](https://cran.r-project.org/mirrors.html) | [![Dependencies: R Version](https://img.shields.io/badge/R-v4.0.2-blue?style=plastic)](https://cran.r-project.org/mirrors.html) |
7
| [![License: GPL-3.0](https://img.shields.io/badge/licence-GPL%20(%3E%3D3)-green?style=plastic)](https://www.gnu.org/licenses) | [![Dependencies: R Package](https://img.shields.io/badge/package-Cairo%20v1.5_12.2-blue?style=plastic)](https://cran.r-project.org/web/packages/Cairo/index.html) |
8
9
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-ggplot2%20v3.3.2-blue?style=plastic)](https://github.com/tidyverse/ggplot2) |
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-lubridate%20v1.7.9-blue?style=plastic)](https://github.com/tidyverse/lubridate) |
10
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-pdftools%20v2.3.1-blue?style=plastic)](https://cran.r-project.org/web/packages/pdftools/index.html) |
11
12
13
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-reshape2%20v1.4.4-blue?style=plastic)](https://cran.r-project.org/web/packages/reshape2/index.html) |
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-reticulate%20v1.16-blue?style=plastic)](https://cran.r-project.org/web/packages/reticulate/index.html)|
|  | [![Dependencies: R Package](https://img.shields.io/badge/package-scales%20v1.1.1-blue?style=plastic)](https://cran.r-project.org/web/packages/scales/index.html) |
14
15
16
17
18
19
20
21
22
23
24
25
26
27


## TABLE OF CONTENTS

   - [AIM](#aim)
   - [REPOSITORY CONTENT](#repository-content)
   - [DESCRIPTIONS OF THE FUNCTIONS](#description-of-the-functions)
   - [HOW TO HOW TO LOAD AND MANIPULATE](#how-to-load-and-manipulate)
   - [VERSIONS](#versions)
   - [LICENCE](#licence)
   - [CITATION](#citation)
   - [CREDITS](#credits)
   - [ACKNOWLEDGEMENTS](#Acknowledgements)
   - [WHAT'S NEW IN](#what's-new-in)
Gael  MILLOT's avatar
Gael MILLOT committed
28

Gael  MILLOT's avatar
Gael MILLOT committed
29

30
## AIM
Gael  MILLOT's avatar
Gael MILLOT committed
31

Gael  MILLOT's avatar
Gael MILLOT committed
32

33
Set of functions that facilitate basic procedures in 1) object analysis, 2) object modification, 3) graphic handling and 4) log file management.
Gael  MILLOT's avatar
Gael MILLOT committed
34

35
The present repository of Cute Little R functions is for beta testing. Ultimately, functions will be provided as packages
Gael  MILLOT's avatar
Gael MILLOT committed
36
37


38
## REPOSITORY CONTENT
Gael  MILLOT's avatar
Gael MILLOT committed
39

Gael's avatar
Gael committed
40
| | |
Gael's avatar
Gael committed
41
| --- | --- |
42
43
44
45
46
47
48
49
| **cute_little_R_functions.R** | file that has to be sourced in R or RStudio |
| **cute_little_R_functions.docx** | same as cute_little_R_functions.R but for better reading (interactive outline at the beginning of the file) |
| **fun_gg_boxplot.docx** | for better reading of the argument description |
| **fun_gg_scatter.docx** | for better reading of the argument description |
| **examples.R** | examples of all the functions, except fun_gg_boxplot() and fun_gg_scatter(), that can be sourced or copied-pasted |
| **examples_gg_boxplot.R** | examples of fun_gg_boxplot() that can be sourced or copied-pasted |
| **examples_gg_scatter.R** | examples of fun_gg_scatter() that can be sourced or copied-pasted |
| **other** | folder containing avorted developments |
Gael  MILLOT's avatar
Gael MILLOT committed
50
51


52
## DESCRIPTIONS OF THE FUNCTIONS
Gael  MILLOT's avatar
Gael MILLOT committed
53

54
55
| Object analysis | |
| --- | --- |
Gael's avatar
Gael committed
56
57
58
| **fun_check()** | check class, type, length, etc., of objects |
| **fun_secu()** | verif that local variables are not present in other envs |
| **fun_info()** | recover object information |
59
60
| **fun_head()** | head of the corners of big 2D objects |
| **fun_tail()** | tail of the corners of big 2D objects |
Gael's avatar
Gael committed
61
| **fun_comp_1d()** | comparison of two 1D datasets (vectors, factors, 1D tables) |
62
| **fun_comp_2d()** | comparison of two 2D datasets (matrices, data.drames, tables) |
Gael's avatar
Gael committed
63
64
| **fun_comp_list()** | comparison of two lists |
| **fun_test()** | test combinations of argument values of a function and return errors (and graphs) |
Gael  MILLOT's avatar
Gael MILLOT committed
65

66
67
| Object modification | |
| --- | --- |
Gael's avatar
Gael committed
68
| **fun_name_change()** | check a vector of character strings and modify any string if present in another vector |
69
70
| **fun_df_remod()** | remodel a data frame to have column name as a qualitative values and vice-versa |
| **fun_round()** | round numbers if decimals present |
Gael's avatar
Gael committed
71
72
73
74
75
| **fun_mat_rotate()** | 90° clockwise matrix rotation |
| **fun_mat_num2color()** | convert a numeric matrix into hexadecimal color matrix |
| **fun_mat_op()** | assemble several matrices with operation |
| **fun_mat_inv()** | return the inverse of a square matrix |
| **fun_mat_fill()** | fill the empty half part of a symmetric square matrix |
76
| **fun_permut()** | progressively break a vector order |
Gael's avatar
Gael committed
77
| **fun_slide()** | return a computation made on a vector using a sliding window |
Gael  MILLOT's avatar
Gael MILLOT committed
78

79
80
| Graphics management | |
| --- | --- |
81
82
83
84
| **fun_width()** | graphic device width depending on the number of classes to plot |
| **fun_open()** | open a GUI or pdf graphic device |
| **fun_prior_plot()** | set graphic parameters before plotting (erase axes for instance) |
| **fun_scale()** | select nice labeling numbers when setting the number of ticks on an axis |
Gael's avatar
Gael committed
85
| **fun_inter_ticks()** | define coordinates of secondary ticks |
86
87
| **fun_post_plot()** | set graphic parameters after plotting (axes redesign for instance) |
| **fun_close()** | close specific graphic devices |
Gael  MILLOT's avatar
Gael MILLOT committed
88

89
90
| Standard graphics | |
| --- | --- |
91
| **fun_empty_graph()** | generate an empty graphic device with text in the middle |
Gael  MILLOT's avatar
Gael MILLOT committed
92

93
94
| gg graphics | |
| --- | --- |
95
| **fun_gg_palette()** | select colors on the ggplot2 default color palette |
96
| **fun_gg_just()** | ggplot2 justification of annotated text or axis labeling, depending on angle |
Gael's avatar
Gael committed
97
98
| **fun_gg_get_legend()** | get the legend of ggplot objects |
| **fun_gg_point_rast()** | ggplot2 raster scatterplot layer |
99
| **fun_gg_boxplot()** | ggplot2 boxplot + dots + means + median/mean values |
Gael's avatar
Gael committed
100
| **fun_gg_scatter()** | ggplot2 scatterplot + lines (up to 6 overlays totally) |
101
| **fun_gg_empty_graph()** | generate an empty graphic device with text in the middle |
Gael  MILLOT's avatar
Gael MILLOT committed
102

103
104
| Graphic extraction | |
| --- | --- |
Gael's avatar
Gael committed
105
106
| **fun_trim()** | display values from a quantitative variable and trim according to defined cut-offs |
| **fun_segmentation()** | segment a dot cloud on a scatterplot and define the dots from another cloud outside the segmentation |
Gael  MILLOT's avatar
Gael MILLOT committed
107

108
109
| Import | |
| --- | --- |
Gael's avatar
Gael committed
110
111
| **fun_pack()** | check if R packages are present and import into the working environment |
| **fun_python_pack()** | check if python packages are present |
Gael  MILLOT's avatar
Gael MILLOT committed
112

113
114
| Print / Exporting results (text & tables) | |
| --- | --- |
115
116
| **fun_report()** | print strings or results into a log file |
| **fun_get_message()** | catch the error/warning/other messages of an evaluated expression |
Gael  MILLOT's avatar
Gael MILLOT committed
117
118


119
## HOW TO LOAD AND MANIPULATE cute_little_R_functions
Gael  MILLOT's avatar
Gael MILLOT committed
120
121


122
Download the desired Tagged version, never the current master, at https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/tags
Gael  MILLOT's avatar
Gael MILLOT committed
123

Gael's avatar
Gael committed
124
For that:
Gael  MILLOT's avatar
Gael MILLOT committed
125

Gael's avatar
Gael committed
126
1) Select the desired tagged release
Gael  MILLOT's avatar
Gael MILLOT committed
127

Gael's avatar
Gael committed
128
129
130
131
132
133
2) Browse files

3) Display the cute_little_R_functions.R as raw file

4) Source the file using the url address. Example:

134
`  source("https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/raw/557976d693e37b499b89c76e4b2142846eb89d5b/cute_little_R_functions.R")  `
Gael  MILLOT's avatar
Gael MILLOT committed
135

136
Complete description of each function is at the beginning of the function body. To obtain it:
Gael  MILLOT's avatar
Gael MILLOT committed
137

138
1) Either use the cute_little_R_functions.docx.
Gael's avatar
Gael committed
139
140

2) Or in the R/RStudio console, type the name of the function without brackets. Example : `fun_info`.
Gael  MILLOT's avatar
Gael MILLOT committed
141
142


143
## VERSIONS
Gael  MILLOT's avatar
Gael MILLOT committed
144

145
The different releases are tagged [here](https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/tags)
Gael  MILLOT's avatar
Gael MILLOT committed
146

Gael  MILLOT's avatar
Gael MILLOT committed
147

148
## LICENCE
Gael  MILLOT's avatar
Gael MILLOT committed
149

150
151
152
This package of scripts can be redistributed and/or modified under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchandability or fitness for a particular purpose.
See the GNU General Public License for more details at https://www.gnu.org/licenses.
Gael  MILLOT's avatar
Gael MILLOT committed
153

Gael  MILLOT's avatar
Gael MILLOT committed
154

155
## CITATION
Gael  MILLOT's avatar
Gael MILLOT committed
156

157
Not yet published
Gael  MILLOT's avatar
Gael MILLOT committed
158
159


160
## CREDITS
Gael  MILLOT's avatar
Gael MILLOT committed
161

162
[Gael A. Millot](https://gitlab.pasteur.fr/gmillot), Hub-CBD, Institut Pasteur, USR 3756 IP CNRS, Paris, France
Gael  MILLOT's avatar
Gael MILLOT committed
163
164


165
## ACKNOWLEDGEMENTS
Gael  MILLOT's avatar
Gael MILLOT committed
166

167
R and R packages developers
Gael  MILLOT's avatar
Gael MILLOT committed
168

169
170
171
172
173
Gitlab developers


## WHAT'S NEW IN

Gael's avatar
Gael committed
174
175
176
177
178
179
180
### v8.0.0

1) Examples improved

2) Some functions debugged


181
182
183
184
185
### v7.0.0

1) Upgrade to R-4.0.2, among other things


186
### v6.0.0
Gael  MILLOT's avatar
Gael MILLOT committed
187
188

1) name of functions changed:
189

Gael  MILLOT's avatar
Gael MILLOT committed
190
fun_param_check()	fun_check()
191

Gael  MILLOT's avatar
Gael MILLOT committed
192
fun_object_info()	fun_info()
193

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
194
fun_1D_comp()	fun_comp_1d()
195

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
196
fun_2D_comp()	fun_comp_2d()
197

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
198
fun_list_comp()	fun_comp_list()
199

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
200
fun_2D_head()	fun_head()
201

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
202
fun_2D_tail()	fun_tail()
203

Gael  MILLOT's avatar
Gael MILLOT committed
204
fun_dataframe_remodeling()	fun_df_remod()
205

Gael  MILLOT's avatar
Gael MILLOT committed
206
fun_by_case_matrix_op()	fun_mat_op()
207

Gael  MILLOT's avatar
Gael MILLOT committed
208
fun_rounding()	fun_round()
209

210
fun_90clock_matrix_rot()	fun_mat_rotate()
211

212
fun_hexa_hsv_color_matrix()	fun_mat_num2color()
213

Gael  MILLOT's avatar
Gael MILLOT committed
214
fun_graph_param_prior_plot()	fun_prior_plot()
215

Gael  MILLOT's avatar
Gael MILLOT committed
216
fun_feature_post_plot()	fun_post_plot()
217

Gael  MILLOT's avatar
Gael MILLOT committed
218
fun_window_width_resizing()	fun_width()
219

Gael  MILLOT's avatar
Gael MILLOT committed
220
fun_open_window()	fun_open()
221

Gael  MILLOT's avatar
Gael MILLOT committed
222
fun_close_specif_window()	fun_close()
223

Gael  MILLOT's avatar
Gael MILLOT committed
224
fun_var_trim_display()	fun_trim()
225

Gael  MILLOT's avatar
Gael MILLOT committed
226
fun_export_data()	fun_report()
Gael  MILLOT's avatar
Gael MILLOT committed
227

228
229


Gael  MILLOT's avatar
Gael MILLOT committed
230
2) new functions added:
231

Gael  MILLOT's avatar
Gael MILLOT committed
232
fun_name_change()
233

Gael  MILLOT's avatar
Gael MILLOT committed
234
fun_mat_fill()
235

236
fun_permut()
237

Gael  MILLOT's avatar
Gael MILLOT committed
238
fun_permut_consec()
239

Gael  MILLOT's avatar
Gael MILLOT committed
240
fun_empty_graph()
241

Gael  MILLOT's avatar
Gael MILLOT committed
242
fun_gg_palette()
243

Gael  MILLOT's avatar
Gael MILLOT committed
244
fun_gg_just()
245

Gael  MILLOT's avatar
saving    
Gael MILLOT committed
246
fun_gg_point_rast()
247

Gael  MILLOT's avatar
Gael MILLOT committed
248
fun_gg_scatter()
249

Gael  MILLOT's avatar
Gael MILLOT committed
250
fun_gg_empty_graph()
251

Gael  MILLOT's avatar
Gael MILLOT committed
252
fun_segmentation()
253

Gael  MILLOT's avatar
Gael MILLOT committed
254
fun_pack()
255

Gael  MILLOT's avatar
Gael MILLOT committed
256
fun_python_pack()
257

Gael  MILLOT's avatar
Gael MILLOT committed
258
fun_warning()
Gael  MILLOT's avatar
Gael MILLOT committed
259

260
261


Gael  MILLOT's avatar
saving    
Gael MILLOT committed
262
3) text error modified in fun_head() and fun_tail(), + deals without all objects but use head() and tail() if not 2D object
Gael  MILLOT's avatar
Gael MILLOT committed
263
264
265

4) in fun_param_check(): (1) has now the class = "vector", (2) argument fun.name added

Gael  MILLOT's avatar
Gael MILLOT committed
266
267
5) writting and debugging message errors improved in all the functions

Gael  MILLOT's avatar
Gael MILLOT committed
268
269
270
6) Functions checked for R version 3.6.1

7) function deprecated:
271

Gael  MILLOT's avatar
Gael MILLOT committed
272
fun_refactorization()
Gael  MILLOT's avatar
Gael MILLOT committed
273
274


275
### v5.1.0
Gael  MILLOT's avatar
Gael MILLOT committed
276
277
278
279

1) bugs corrected in fun_2D_head() and fun_2D_tail() functions


280
### v5.0.0
Gael  MILLOT's avatar
Gael MILLOT committed
281
282

1) fun_2D_head() function added
283

Gael  MILLOT's avatar
Gael MILLOT committed
284
2) fun_2D_tail() function added
285

Gael  MILLOT's avatar
Gael MILLOT committed
286
287
288
3) argument "noquote" added in fun_export_data()


289
### v4.9.0
Gael  MILLOT's avatar
Gael MILLOT committed
290
291
292
293

1) fun_mat_inv() function added


294
### v4.8.0
Gael  MILLOT's avatar
Gael MILLOT committed
295
296
297
298

1) magnific argument removed in fun_feature_post_plot() because no need anymore


299
### v4.7.0
Gael  MILLOT's avatar
Gael MILLOT committed
300
301
302
303

1) check of numeric arguments: class = "numeric" -> mode = "numeric" to allow for integers values in these arguments


304
### v4.6.0
Gael  MILLOT's avatar
Gael MILLOT committed
305
306
307
308

1) fun_by_case_matrix_op() added


309
### v4.5.0
Gael  MILLOT's avatar
Gael MILLOT committed
310
311
312
313
314
315

1) fun_open_window() improved to deal with Linux systems

2) fun_graph_param_prior_plot() improved to deal with Linux systems


316
### v4.4.0
Gael  MILLOT's avatar
Gael MILLOT committed
317
318
319
320

1) fun_dataframe_remodeling() now add a ini_rowname column in the output data frame when it is coherent and when initial row names are available (not NULL)


321
### v4.3.0
Gael  MILLOT's avatar
Gael MILLOT committed
322
323
324
325

1) fun_object_info() now manages object class "ordered" "factor"


326
### v4.2.0
Gael  MILLOT's avatar
Gael MILLOT committed
327
328
329
330

1) bug in the fun_2D_comp() function fixed


331
### v4.1.0
Gael  MILLOT's avatar
Gael MILLOT committed
332
333
334
335

1) text.corner replaced by corner.text everywhere


336
### v4.0.0
Gael  MILLOT's avatar
Gael MILLOT committed
337
338
339
340
341
342
343
344
345
346

1) fun_var_trim_display() function added

2) fun_feature_post_plot() function now provides additional coordinates when there are margins between the figure region and the device region

3) fun_2D_comp() function now provide the common row and column names, and a bug fixed in the detection of identical row or column content

4) error messages now mention the function that generates this message 


347
### v3.1.0
Gael  MILLOT's avatar
Gael MILLOT committed
348
349
350
351
352
353

1) fun_export_data() function modified: argument data cannot be NULL

2) the debugging line containing r_debugging_tools-v1.2.R updated for the new position of this script


354
### v3.0.0
Gael  MILLOT's avatar
Gael MILLOT committed
355

Gael  MILLOT's avatar
Gael MILLOT committed
356
1) cute_little_functions.R renamed cute_little_R_functions.R
Gael  MILLOT's avatar
Gael MILLOT committed
357

Gael  MILLOT's avatar
Gael MILLOT committed
358
359
2) function fun_dataframe_flipping() has been renamed fun_dataframe_remodeling()

Gael  MILLOT's avatar
Gael MILLOT committed
360
3) more examples added, also draws added in the .docx file for fun_dataframe_remodeling()
Gael  MILLOT's avatar
Gael MILLOT committed
361
362


363
### v2.0.1
Gael  MILLOT's avatar
Gael MILLOT committed
364
365
366
367

1) functions that use other functions from this toolset now check if these required functions are indeed present in the R environment


368
### v2.0.0
Gael  MILLOT's avatar
Gael MILLOT committed
369
370
371
372
373
374
375
376

1) fun_feature_post_plot() function improved: Now independent magnification for x axis/labels and y axis/labels. BEWARE: argument names have been modified

2) Bug corrected in fun_graph_param_prior_plot() function

3) Bug corrected in fun_refactorization() function


377
378
### v1.3

Gael  MILLOT's avatar
Gael MILLOT committed
379
1) fun_1D_comp() function improved: provide the common elements, common names and common levels if exist
Gael  MILLOT's avatar
Gael MILLOT committed
380
381


Gael's avatar
Gael committed
382
383
384
### v1

Everything