Set of R functions for the development of R functions, written according to the cute_project specifications.
| Function | Description |
|---|---|
| arg_check() | Check expected values of arguments of functions: class, type, mode, length, restricted values panel, kind of numeric values in addition to the distinction between 'integer' and 'double' (proportion only? Inf values authorized? negative values authorized? Integers of type 'double'?). |
| arg_test() | Test a set of values for a defined set of arguments of a function. Contrary to testthat::test_that(), the function test a batch of values and control only if an error is returned or not. |
| env_check() | Verify that object names in the environment defined by the pos argument are identical or not to object names in the above environments (following R Scope). This can be used to verify that names used for objects inside a function or in the working environment do not override names of objects already present in the above R environments, following the R scope. |
| get_message() | Return the error, warning or simple (non error non warning) message if ever exist of an instruction written between quotes. |
| is_function_here() | Check if required functions are present in installed packages. This controls modifications in of function names package versions. |
| is_package_here() | Check if required packages are installed locally. |
| is_python_package_here() | Check if required python packages are installed locally. |
| report | Print a character string or a data object into a same log file. |
Read vignette("cuteDev") for more details.
The different cuteDev releases are tagged here.
cuteDev can be currently be installed from GitHub:
install.packages("remotes")
remotes::install_github("https://github.com/yushiHn/cuteDev")Older versions can be installed like this:
v <- "v1.0" # desired tag version
remotes::install_github(paste0("https://github.com/yushiHn/cuteDev/tree/", v))This package 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.
If you are using functions of cuteDev, please cite:
Han Y, Serizay J, Millot GA (2023). The R cuteDev package. https://github.com/yushiHn/cuteDev/.
Yushi Han, Bioinformatics and Biostatistics Hub, Institut Pasteur, Paris, France
Jacques Serizai, Spatial Regulation of Genomes team, Institut Pasteur, Paris, France
Gael A. Millot, Bioinformatics and Biostatistics Hub, Institut Pasteur, Paris, France
The developers & maintainers of R as well as packages used in the cuteDev functions.