search

florianhartig / BayesianTools

General-Purpose MCMC and SMC Samplers and Tools for Bayesian Statistics
https://cran.r-project.org/web/packages/BayesianTools/index.html
119 stars 29 forks source link

Updated help file for BayesianSetupGenerateParallel.R #255

Closed TahminaMojumder closed 1 year ago

TahminaMojumder commented 1 year ago
line 13 what does parallelization mean here? @param parallel: from description it seems like a boolean vector but in the code there is also an option for "auto"!!! What does "external" mean here?    
line 12 I cannot find @note in code. How can @note be defined?
line  8 It is not entirely clear what options are available for "packages", "variables" and "dll"          
florianhartig commented 1 year ago

Hi @TahminaMojumder - can you look at this PR - also note that the checks don't run, do they run for you on your machine? I suspect that this is because a line in the code was erased.

florianhartig commented 1 year ago

Hi Tahmina, In this branch, the checks produce an error, the slash n is apparently not supported by Roxygen, needs to be corrected

florianhartig commented 1 year ago

Hi @TahminaMojumder,

a) I think you accidentally changed a few other files as well, see file changes of the last commit - I would revert this, just because of tidiness

b) For the list, don't use itemise, use standard markdown commands, this is better to read / maintain. See https://mpn.metworx.com/packages/roxygen2/7.1.1/articles/rd-formatting.html#lists-2

TahminaMojumder commented 1 year ago

Hi @TahminaMojumder,

a) I think you accidentally changed a few other files as well, see file changes of the last commit - I would revert this, just because of tidiness

b) For the list, don't use itemise, use standard markdown commands, this is better to read / maintain. See https://mpn.metworx.com/packages/roxygen2/7.1.1/articles/rd-formatting.html#lists-2

Hi @TahminaMojumder,

a) I think you accidentally changed a few other files as well, see file changes of the last commit - I would revert this, just because of tidiness

b) For the list, don't use itemise, use standard markdown commands, this is better to read / maintain. See https://mpn.metworx.com/packages/roxygen2/7.1.1/articles/rd-formatting.html#lists-2

TahminaMojumder commented 1 year ago

Hi @TahminaMojumder,

a) I think you accidentally changed a few other files as well, see file changes of the last commit - I would revert this, just because of tidiness

b) For the list, don't use itemise, use standard markdown commands, this is better to read / maintain. See https://mpn.metworx.com/packages/roxygen2/7.1.1/articles/rd-formatting.html#lists-2

TahminaMojumder commented 1 year ago

There were some files that did not have changes but was still committed. Maybe, when I made changes from the windows it was creating white spaces and considering the white spaces as a change.