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

Clarify cleanup steps #21

Merged
merged 4 commits into from
Jan 12, 2024
Merged

Clarify cleanup steps #21

merged 4 commits into from
Jan 12, 2024

Conversation

shntnu
Copy link
Member

@shntnu shntnu commented Jan 10, 2024

  • Removed metadata tracking because we no longer do that
  • Added a section for DVC

I used https://github.com/broadinstitute/2021_09_01_VarChAMP-data as a reference when making these updates.

@shntnu
Copy link
Member Author

shntnu commented Jan 12, 2024

Thanks @bethac07

Do you speak for Erin too (on this one) or should we wait for her?

@ErinWeisbart
Copy link
Member

I have a philosophical question - is this template intended just for our use or are we trying to encourage broader adoption? If broader, then I would leave in metadata tracking, updating language to clarify that all users should track metadata, we have a system (w/link), and if you don't have a system, use this template provided.

@shntnu
Copy link
Member Author

shntnu commented Jan 12, 2024

Great point – +1 to encourage broader adoption

How is this text:

We recommend all users, both internal and external, to diligently track project metadata. For those without a system, a template is provided below.

@ErinWeisbart
Copy link
Member

I like that sentence :)

@shntnu
Copy link
Member Author

shntnu commented Jan 12, 2024

@ErinWeisbart all set

@ErinWeisbart
Copy link
Member

Except for the metadata log is in the Setup section and your first instructions are to delete Setup. So I suggest moving it to its own section, or clarifying that somehow. Otherwise LGTM.

@shntnu
Copy link
Member Author

shntnu commented Jan 12, 2024

Except for the metadata log is in the Setup section and your first instructions are to delete Setup. So I suggest moving it to its own section, or clarifying that somehow. Otherwise LGTM.

Ah good catch. All set now. Merging

Thank you @bethac07 @ErinWeisbart!

@shntnu shntnu merged commit 8ddd1db into master Jan 12, 2024
@shntnu shntnu deleted the clarify-cleanup branch January 12, 2024 22:27
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.

3 participants