Correct documentation for cellassign() function

kieranrcampbell commented 5 years ago

Need correct roxygen header to pass bioccheck.

kieranrcampbell commented 5 years ago

@Irrationone can you just clarify the meaning of the following parameters

period_epochs = 400,
no_change_rel_thres = 1e-5,
no_change_periods = 2
gamma_init = NULL,
 num_runs = 1,

Irrationone commented 5 years ago

period_epochs is specific to the VB version (just adjusts how long a period is for message and convergence assessment);
no_change_rel_thres is for the VB version as well, adjusts what the relative threshold is for considering convergence between successive periods
no_change_periods is how many successive periods that have to be at no_change_rel_thres to be considered converged
gamma_init is for specifying an initialization for gamma -- can be removed to be concise
num_runs adjusts the number of EM restarts

kieranrcampbell commented 5 years ago

Addressed in bcbe9dfaa31349b029195e9f7fabac8020dff8b8 and previous commit - passes BiocCheck() (see #12 )

Irrationone / cellassign