Description Usage Arguments Value Author(s) Examples

View source: R/nucleoSimInternFunctions.R

Validate that all values passed to the function are formated
for the `syntheticNucMapFromDist`

function.

1 2 | ```
syntheticNucMapFromDistValidation(wp.num, wp.del, wp.var, fuz.num, fuz.var,
max.cover, nuc.len, len.var, lin.len, rnd.seed, as.ratio)
``` |

`wp.num` |
a non-negative |

`wp.del` |
a non-negative |

`wp.var` |
a non-negative |

`fuz.num` |
a non-negative |

`fuz.var` |
a non-negative |

`max.cover` |
a positive |

`nuc.len` |
a non-negative |

`len.var` |
a non-negative |

`lin.len` |
a non-negative |

`rnd.seed` |
a single value, interpreted as an |

`as.ratio` |
a |

`0`

indicating that all parameters validations have been
successful.

Astrid Deschenes

1 2 3 4 5 6 7 8 9 10 11 12 13 14 | ```
## The function returns 0 when all paramaters are valid
nucleoSim:::syntheticNucMapFromDistValidation(wp.num = 20, wp.del = 2,
wp.var = 3, fuz.num = 10, fuz.var = 5, max.cover = 100, nuc.len = 147,
len.var = 4, lin.len = 40, rnd.seed = 201, as.ratio = FALSE)
## The function raises an error when at least one paramater is not valid
## Not run: nucleoSim:::syntheticNucMapFromDistValidation(wp.num = -1,
wp.del = 2, wp.var = 3, fuz.num = 10, fuz.var = 5, max.cover = 100,
nuc.len = 147, len.var = 4, lin.len = 40, rnd.seed = 201, as.ratio = FALSE)
## End(Not run)
## Not run: nucleoSim:::syntheticNucMapFromDistValidation(wp.num = 20,
wp.del = 2, wp.var = -3, fuz.num = 10, fuz.var = 5, max.cover = 100,
nuc.len = 147, len.var = 4, lin.len = 40, rnd.seed = 201, as.ratio = FALSE)
## End(Not run)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.