`setupProject(..., Restart = TRUE)` creates RStudio project, but `setupProject(..., Restart = FALSE)` doesn't

[CeresBarros]

The code below creates an RStudio project file and .Rproj.user folder, in addtion to restarting RStudio.

Require::Require("PredictiveEcology/SpaDES.project@windowsTesting")
out <- setupProject(name = "LandRDemo_coreVeg",
                    options = list("reproducible.useTerra" = TRUE),
                    paths = list(projectPath = "D:/GitHub/LandR-tutorials/LandRDemo_coreVeg",
                                 modulePath = "D:/GitHub/LandR-tutorials/LandRDemo_coreVeg/modules",
                                 scratchPath = tempdir(),
                                 packagePath = "D:/GitHub/LandR-tutorials/packages"),
                    modules = c("PredictiveEcology/Biomass_speciesData@terra-migration",
                                "PredictiveEcology/Biomass_borealDataPrep@terra-migration",
                                "PredictiveEcology/Biomass_speciesParameters@development",
                                "PredictiveEcology/Biomass_core@terra-migration",
                                "PredictiveEcology/Biomass_validationKNN@development"),
                   Restart = TRUE
)

When, Restart = FALSE, however the RStudio project file and .Rproj.user folder are not created. Is this intended?

I'm thinking it may be good to create the RStudio project file and .Rproj.user even if not restarting (i.e. when Restart = FALSE), as a user may want to use the code above in a "discardable" script to initiate the project and then open the project directly from RStudio at a later date.

[eliotmcintire]

The assumption was that a user doesn't want to make a Rstudio project, or else they would say Restart = TRUE. Not everyone wants one... Maybe there is so little cost of "creating" that file and that directory that maybe we just do it if they don't already exist. Having said, why wouldn't the use say Restart = TRUE as the mechanism for getting an Rstudio project. Noting that if we did make that file and folder, the current session wouldn't report that it is "in" a project... so it would be a bit sneaky, no?

[CeresBarros]

Having said, why wouldn't the use say Restart = TRUE as the mechanism for getting an Rstudio project.

Because of the example I stated above "a user may want to use the code above in a "discardable" script to initiate the project and then open the project directly from RStudio at a later date."
By "initiate" I meant "create the RStudio Project and the folder structure"

I guess I'm thinking of creating two parameters, one that controls for RStudio Project creation, and another that triggers restarting and can only be TRUE if the the first is also TRUE. Regardless, the documentation of Restart needs to be made clearer for the current mechanism.