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

Adjust code, headers, and vignette for required/not required arguments #56

Merged
merged 3 commits into from
Aug 23, 2024

Conversation

kweav
Copy link
Collaborator

@kweav kweav commented Aug 15, 2024

The changes in this PR address requiring the cell_line argument for gimap_annotate() and clarifying pg_metadata/sample_metadata (which one is required/used) for setup_data().

For the cell_line argument:

  • I removed the default value
  • Explained in the header that it is required
  • added providing its value to the headers for this and all subsequent functions
  • Provided more clarity in the vignette about providing it
  • Also included a toupper() when utilizing the argument to filter the DepMap data since the stripped cell line column appears to have capitalized cell lines upon inspection.

For the pg_metadata argument:

  • I removed the argument from documentation, code, and the test function as it's not used and certainly was not required.

For the sample_metadata argument:

  • I made it a required argument such that if it's not provided the NULL default will trigger the program to stop and make the user provide it since it's necessary for later steps.
  • I tried to clarify the description of this in the vignette.

@kweav kweav requested a review from cansavvy August 15, 2024 04:20
Copy link
Collaborator

@cansavvy cansavvy left a comment

Choose a reason for hiding this comment

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

This is great! Let's merge it. Between this and a little thing I added over on #57 I think this will cover it!

@cansavvy cansavvy merged commit e41de2b into main Aug 23, 2024
4 of 7 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.

2 participants