Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi there, thanks for your contribution!
Please fill out this template to help us review your code.
Remember, the more context you provide, the faster the review will go!
For more information about filling out this template, please see the OpenScPCA documentation on filing pull requests:
https://openscpca.readthedocs.io/en/latest/contributing-to-analyses/creating-pull-requests/
Before filing the pull request, you can also feel free to delete the italicized instruction lines in this template.
Purpose/implementation Section
In this section, tell reviewers about the scope and purpose of the code in the pull request.
Please link to the GitHub issue that this pull request addresses.
If applicable, you can also link to the associated GitHub Discussion.
What is the goal of this pull request?
Include the scientific or analytical goals, if applicable.
Briefly describe the general approach you took to achieve this goal.
If known, do you anticipate filing additional pull requests to complete this analysis module?
Results
Delete this section if no results are associated with your pull request.
In this section, tell reviewers about what kinds of results (if any) your code produces.
What is the name of your results bucket on S3?
Results should be uploaded to your bucket so they are available during review.
See here for instructions on how to upload to your bucket:
https://openscpca.readthedocs.io/en/latest/software-platforms/aws/working-with-s3-buckets/
What types of results does your code produce (e.g., table, figure)?
What is your summary of the results?
Provide directions for reviewers
In this section, tell reviewers what kind of feedback you are looking for.
This information will help guide their review.
What are the software and computational requirements needed to be able to run the code in this PR?
This information will help reviewers run the code during review, if applicable.
For software, how should reviewers set up their environment (e.g.,
renv
orconda
) to run this code?For compute, can reviewers run this code on their laptop, or do they need additional computational resources such as RAM or storage?
Please make sure this information, if applicable, is documented in the README.md file.
Are there particularly areas you'd like reviewers to have a close look at?
Is there anything that you want to discuss further?
Author checklists
Check all those that apply.
Note that you may find it easier to check off these items after the pull request is actually filed.
Analysis module and review
README.md
has been updated to reflect code changes in this pull request.Reproducibility checklist
Dockerfile
.environment.yml
file.renv.lock
file.