updated function comments and vignette