Skip to content

add short metric descriptions to README - #647

Merged
scottgigante-immunai merged 13 commits into
openproblems-bio:mainfrom
danielStrobl:bi-graph-metrics-readme
Nov 2, 2022
Merged

add short metric descriptions to README#647
scottgigante-immunai merged 13 commits into
openproblems-bio:mainfrom
danielStrobl:bi-graph-metrics-readme

Conversation

@danielStrobl

Copy link
Copy Markdown
Collaborator

Metric descriptions for website, batch_integration_graph subtask

Submission type

  • This submission adds a new dataset
  • This submission adds a new method
  • This submission adds a new metric
  • This submission adds a new task
  • This submission adds a new Docker image
  • This submission fixes a bug (link to related issue: )
  • This submission adds a new feature not listed above

Testing

  • This submission was written on a forked copy of SingleCellOpenProblems
  • GitHub Actions "Run Benchmark" tests are passing on this base branch of this pull
    request (include link to passed test: )
  • If this pull request is not ready for review (including passing the "Run
    Benchmark" tests), I will open this PR as a draft (click on the down arrow next to the
    "Create Pull Request" button)

Submission guidelines

  • This submission follows the guidelines in our
    Contributing document
  • I have checked to ensure there aren't other open Pull Requests for the
    same update/change

PR review checklist

This PR will be evaluated on the basis of the following checks:

  • The task addresses a valid open problem in single-cell analysis
  • The latest version of master is merged and tested
  • The methods/metrics are imported to __init__.py and were tested in the pipeline
  • Method and metric decorators are annotated with paper title, year, author, code
    version, and date
  • The README gives an outline of the methods, metrics and datasets in the folder
  • The README provides a satisfactory task explanation (for new tasks)
  • The sample test data is appropriate to test implementation of all methods and
    metrics (for new tasks)

@codecov

codecov Bot commented Oct 25, 2022

Copy link
Copy Markdown

Codecov Report

Base: 94.96% // Head: 94.96% // No change to project coverage 👍

Coverage data is based on head (05489a5) compared to base (2a1c8fb).
Patch has no changes to coverable lines.

❗ Current head 05489a5 differs from pull request most recent head d1ff228. Consider uploading reports for the commit d1ff228 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #647   +/-   ##
=======================================
  Coverage   94.96%   94.96%           
=======================================
  Files         153      153           
  Lines        3891     3891           
  Branches      201      201           
=======================================
  Hits         3695     3695           
  Misses        128      128           
  Partials       68       68           
Flag Coverage Δ
unittests 94.96% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@LuckyMD

LuckyMD commented Oct 25, 2022

Copy link
Copy Markdown
Collaborator

Hmm... I'm just testing out gh and i pushed some changes to the https://github.com/openproblems-bio/openproblems/tree/bi-graph-metrics-readme branch. Not sure how to push them to this PR...

@scottgigante-immunai

Copy link
Copy Markdown
Collaborator

Since you're an admin of openproblems this PR should give you authority to push to @danielStrobl's branch if you add it as a new git remote. Not sure how gh works though.. maybe you can just open a separate PR (with this PR potentially as the target)

@LuckyMD

LuckyMD commented Nov 2, 2022

Copy link
Copy Markdown
Collaborator

The only thing I noticed I could do is make a PR to @danielStrobl's fork with the changes in the upstream.

That's now here: danielStrobl#32

@LuckyMD

LuckyMD commented Nov 2, 2022

Copy link
Copy Markdown
Collaborator

Okay, this is now mergeable from my side when tests pass

@scottgigante-immunai
scottgigante-immunai merged commit e481460 into openproblems-bio:main Nov 2, 2022
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