Skip to content

Conversation

@PhilBoileau
Copy link
Collaborator

This PR includes the draft of a vignette instructing users on how best to organize their simulation study. Comments and suggestions welcome.

@jpdunc23 jpdunc23 self-requested a review January 25, 2023 00:31
@jpdunc23 jpdunc23 added the documentation Improvements or additions to documentation label Jan 25, 2023
@jpdunc23 jpdunc23 marked this pull request as draft January 31, 2023 19:45
Copy link
Contributor

@jpdunc23 jpdunc23 left a comment

Choose a reason for hiding this comment

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

Looks good. I added a suggestion to try optparse in conjunction with bash scripts to run meal.R.

It would be good to point users to an example simulation that follows this exact structure. @PhilBoileau, can we point to one of yours?

@jpdunc23 jpdunc23 requested a review from tiffanymtang January 31, 2023 19:49
@jpdunc23
Copy link
Contributor

@tiffanymtang do you mind taking a pass? How do you find this suggested structure?

@tiffanymtang
Copy link
Collaborator

Looks great! Thanks so much! @PhilBoileau

@jpdunc23 jpdunc23 marked this pull request as ready for review January 31, 2023 21:00
@jpdunc23
Copy link
Contributor

@PhilBoileau, feel free to merge when ready.

@PhilBoileau
Copy link
Collaborator Author

Thanks for reviewing, @jpdunc23 and @tiffanymtang! I've made some minor touch ups and have included links to existing projects that (somewhat loosely) follow the suggested setup. I'll tidy them up in the coming weeks to better align with our recommendations.

@PhilBoileau PhilBoileau merged commit ff78470 into main Feb 1, 2023
@PhilBoileau PhilBoileau deleted the directory-structure-vignette branch February 1, 2023 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants