diff --git a/README.md b/README.md index 3adb0b3282fc4facf4dc070d18209be931a9e6ca..5a5cbb92a25464c2303a39ab00e90f3eaa751c40 100644 --- a/README.md +++ b/README.md @@ -57,67 +57,67 @@ The present repository of Cute Little R functions is for beta testing. Ultimatel | Object analysis | | | --- | --- | -| **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 | -| **fun_head() | head of the left or right of big 2D objects | -| **fun_tail() | tail of the left or right of big 2D objects | -| **fun_comp_1d() | comparison of two 1D datasets (vectors, factors, 1D tables) | -| **fun_comp_2d() | comparison of two 2D datasets (row & col names, dimensions, etc.) | -| **fun_comp_list() | comparison of two lists | -| **fun_test() | test combinations of argument values of a function and return errors (and graphs) | +| **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 | +| **fun_head()** | head of the left or right of big 2D objects | +| **fun_tail()** | tail of the left or right of big 2D objects | +| **fun_comp_1d()** | comparison of two 1D datasets (vectors, factors, 1D tables) | +| **fun_comp_2d()** | comparison of two 2D datasets (row & col names, dimensions, etc.) | +| **fun_comp_list()** | comparison of two lists | +| **fun_test()** | test combinations of argument values of a function and return errors (and graphs) | | Object modification | | | --- | --- | -| **fun_name_change() | check a vector of character strings and modify any string if present in another vector | -| **fun_df_remod() | remodeling a data frame to have column name as a qualitative values and vice-versa | -| **fun_round() | rounding number if decimal present | -| **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 | -| **fun_permut() | progressively breaks a vector order | -| **fun_slide() | return a computation made on a vector using a sliding window | +| **fun_name_change()** | check a vector of character strings and modify any string if present in another vector | +| **fun_df_remod()** | remodeling a data frame to have column name as a qualitative values and vice-versa | +| **fun_round()** | rounding number if decimal present | +| **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 | +| **fun_permut()** | progressively breaks a vector order | +| **fun_slide()** | return a computation made on a vector using a sliding window | | Graphics management | | | --- | --- | -| **fun_width() | window width depending on classes to plot | -| **fun_open() | open a GUI or pdf graphic window | -| **fun_prior_plot() | set graph param before plotting (erase axes for instance) | -| **fun_scale() | select nice label numbers when setting number of ticks on an axis | -| **fun_inter_ticks() | define coordinates of secondary ticks | -| **fun_post_plot() | set graph param after plotting (axes redesign for instance) | -| **fun_close() | close specific graphic windows | +| **fun_width()** | window width depending on classes to plot | +| **fun_open()** | open a GUI or pdf graphic window | +| **fun_prior_plot()** | set graph param before plotting (erase axes for instance) | +| **fun_scale()** | select nice label numbers when setting number of ticks on an axis | +| **fun_inter_ticks()** | define coordinates of secondary ticks | +| **fun_post_plot()** | set graph param after plotting (axes redesign for instance) | +| **fun_close()** | close specific graphic windows | | Standard graphics | | | --- | --- | -| **fun_empty_graph() | text to display for empty graphs | +| **fun_empty_graph()** | text to display for empty graphs | | gg graphics | | | --- | --- | -| **fun_gg_palette() | ggplot2 default color palette | -| **fun_gg_just() | ggplot2 justification of the axis labeling, depending on angle | -| **fun_gg_get_legend() | get the legend of ggplot objects | -| **fun_gg_point_rast() | ggplot2 raster scatterplot layer | -| **fun_gg_boxplot() | ggplot2 boxplot + background dots if required | -| **fun_gg_scatter() | ggplot2 scatterplot + lines (up to 6 overlays totally) | -| **fun_gg_empty_graph() | text to display for empty graphs | +| **fun_gg_palette()** | ggplot2 default color palette | +| **fun_gg_just()** | ggplot2 justification of the axis labeling, depending on angle | +| **fun_gg_get_legend()** | get the legend of ggplot objects | +| **fun_gg_point_rast()** | ggplot2 raster scatterplot layer | +| **fun_gg_boxplot()** | ggplot2 boxplot + background dots if required | +| **fun_gg_scatter()** | ggplot2 scatterplot + lines (up to 6 overlays totally) | +| **fun_gg_empty_graph()** | text to display for empty graphs | | Graphic extraction | | | --- | --- | -| **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 | +| **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 | | Import | | | --- | --- | -| **fun_pack() | check if R packages are present and import into the working environment | -| **fun_python_pack() | check if python packages are present | +| **fun_pack()** | check if R packages are present and import into the working environment | +| **fun_python_pack()** | check if python packages are present | | Print / Exporting results (text & tables) | | | --- | --- | -| **fun_report() | print string or data object into output file | -| **fun_get_message() | return error/warning/other messages of an expression (that can be exported) | +| **fun_report()** | print string or data object into output file | +| **fun_get_message()** | return error/warning/other messages of an expression (that can be exported) | ## HOW TO LOAD AND MANIPULATE cute_little_R_functions @@ -125,25 +125,23 @@ The present repository of Cute Little R functions is for beta testing. Ultimatel Download the desired Tagged version, never the current master, at https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/tags - For that: +For that: - 1) Select the desired tagged release - - 2) Browse files - - 3) Display the cute_little_R_functions.R as raw file - - 4) Source the file using the url address. Example - ` - source("https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/raw/557976d693e37b499b89c76e4b2142846eb89d5b/cute_little_R_functions.R") - ` +1) Select the desired tagged release +2) Browse files + +3) Display the cute_little_R_functions.R as raw file + +4) Source the file using the url address. Example: + +`source("https://gitlab.pasteur.fr/gmillot/cute_little_R_functions/-/raw/557976d693e37b499b89c76e4b2142846eb89d5b/cute_little_R_functions.R")` Description of the functions is at the beginning of the function body. To obtain it: - Either read the cute_little_functions.docx (or open the cute_little_R_functions.R file). - - Or in the R/RStudio console, type the name of the function without brackets. Example : `fun_info`. +1) Either read the cute_little_functions.docx (or open the cute_little_R_functions.R file). + +2) Or in the R/RStudio console, type the name of the function without brackets. Example : `fun_info`. ## VERSIONS @@ -370,12 +368,9 @@ fun_refactorization() ### v1.3 -Everything - - - - - 1) fun_1D_comp() function improved: provide the common elements, common names and common levels if exist +### v1 + +Everything