Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated help file for BayesianSetupGenerateParallel.R #255

Merged

Conversation

TahminaMojumder
Copy link
Contributor

No description provided.

@TahminaMojumder
Copy link
Contributor Author

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"    

#' By default a copy of your workspace is exported. However, depending on your workspace this can be very inefficient.
#'
#' Alternatively you can specify the environments and packages in the likelihood function (e.g. BayesianTools::VSEM() instead of VSEM()).
#' @param parallel should a parallel R cluster be used? If set to T, machine will
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the line breaks, I can't see which words have changed in the diff because all seems to be changed - could you change back to how it was before?

#' By default a copy of your workspace is exported. However, depending on your workspace this can be very inefficient.
#'
#' Alternatively you can specify the environments and packages in the likelihood function (e.g. BayesianTools::VSEM() instead of VSEM()).
#' @param parallel should a parallel R cluster be used? If set to T, machine will
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why "machine"?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably you mean the operating system

@florianhartig
Copy link
Owner

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 florianhartig marked this pull request as ready for review October 23, 2023 11:32
@florianhartig
Copy link
Owner

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

@florianhartig
Copy link
Owner

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

TahminaMojumder commented Nov 3, 2023

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.

@florianhartig florianhartig merged commit 1436e76 into florianhartig:master Nov 8, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants