Check Datasets for Version Compatibility - veeninglab/BactMAP GitHub Wiki

In version 0.1.0.1, some variable names were changed. While the functions using these names are adapted to recognize the old variable names, we are a bit cautious and added the function checkVersionCompatible() to be sure you can change your dataframes easily if you run into trouble with the new variable names.

Please, if you encounter problems with the new variable names, contact us so we can fix it!

Usage

checkVersionCompatible(oldDataFrame, returnDataFrame=TRUE)

Arguments

Argument Description
oldDataFrame Any dataframe created with BactMAP of which you wish to know whether it's compatible with the current version of bactMAP.
returnDataFrame Set this variable to FALSE if you just want to check for issues, and to TRUE if you want to get a fixed (or, if no problems are found, untouched) dataframe returned.

Details

The function standardly fixes possible compatibility problems (between version 0.1.0.0 and 0.1.0.1) and returns the fixed dataframe (or the same dataframe if no problems are found). If you just want to check for issues, set returnDataFrame to FALSE. Note that, in theory, old dataframes shouldn't cause compatibility problems. If you encounter them, you can solve them with this function, but contact us as well so we can fix it.

Value

If returnDataFrame is set to TRUE, a dataframe with the correct variable names is returned.

Examples

#using TurnedCell4 dataframe from the example dataset (https://veeninglab.com/f/example_datasets.zip)

checkVersionCompatible(TurnedCell4, returnDataFrame=FALSE)