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

Addition of constellation homologies workflow with tutorials #690

Merged
merged 56 commits into from
Sep 20, 2021

Conversation

jgerardhodge
Copy link
Contributor

Describe your changes
Adds new functions under the homology module of PlantCV which consists of:
*space - generates additional metavariables for acute pseudo-landmarks
*starscape - function for dimensionality reduction of segmented plant data to generate constellations of points in a time series step
*constella - function for de novo homology grouping of nearest neighbors in these constellations through agglomerative clustering
*constellaQC - scores homology groupings against a known standard to estimate valid call rates in addition to clumping and splitting errors.

While space and constellaQC are considered optional functions due to their limited scope for datatypes or utility as QC measures respectively starscape and constella comprise the bulk of the constellation approach to de novo homology assessment.

In addition 4 tutorial md files have been included which form a series of "acute_plm_tutorial". The first two tutorials demonstrate the usage of acute for pseudo-landmarking as well as an implementation for running this script on batch datasets. The second two tutorials (i.e. 3 & 4) consist of a demonstration of the constellation grouping methodology on this simplified dataset as well as best practices for it's usage.

Type of update
Is this a:

  • New feature or feature enhancement

Associated issues
Reference associated issue numbers. Does this pull request close any issues?

Additional context
Add any other context about the problem here.

jgerardhodge and others added 6 commits September 3, 2020 22:56
Created plm_homologies directory containing de novo homology pipeline and migrated acute into this directory.
Cleaned up names of functions being called by init so that import of plm_homologies is successful.
The base functions required for homology grouping (space [optional], starscape, and constella as well as a QC screening script (constellaQC) have been added via the homology module in PCV.  Markdown files have also been added which present the implementation of acute (tutorials 1 & 2) as well as the usage of homology on segmented plant data (tutorials 3 & 4).
Adjusting format size of graphs for ease of better display purposes.
Moving existing .md files from ~/docs/ to ~/docs/tutorials/ for the plm analysis and homology workflow.
@nfahlgren
Copy link
Member

@jgerardhodge is the new pull request just for merging with 4.x? If so, we can update this PR to compare to 4.x instead

@nfahlgren nfahlgren changed the base branch from master to 4.x September 15, 2021 19:25
@nfahlgren nfahlgren added this to In progress in PlantCV4 via automation Sep 15, 2021
@nfahlgren nfahlgren added this to the PlantCV v4.x milestone Sep 15, 2021
@nfahlgren nfahlgren added new feature New feature ideas and solutions work in progress Mark work in progress labels Sep 15, 2021
@codecov
Copy link

codecov bot commented Sep 15, 2021

Codecov Report

Merging #690 (0e20ac5) into 4.x (d3311d3) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##               4.x      #690    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          145       150     +5     
  Lines         6400      6631   +231     
==========================================
+ Hits          6400      6631   +231     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

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

Impacted Files Coverage Δ
plantcv/plantcv/__init__.py 100.00% <ø> (ø)
plantcv/plantcv/homology/__init__.py 100.00% <100.00%> (ø)
plantcv/plantcv/homology/acute.py 100.00% <100.00%> (ø)
plantcv/plantcv/homology/constella.py 100.00% <100.00%> (ø)
plantcv/plantcv/homology/constellaqc.py 100.00% <100.00%> (ø)
plantcv/plantcv/homology/space.py 100.00% <100.00%> (ø)
plantcv/plantcv/homology/starscape.py 100.00% <100.00%> (ø)
... and 3 more

@nfahlgren nfahlgren added ready to review and removed work in progress Mark work in progress labels Sep 20, 2021
Copy link
Member

@nfahlgren nfahlgren left a comment

Choose a reason for hiding this comment

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

Thanks John!

@nfahlgren nfahlgren merged commit 6d105fc into danforthcenter:4.x Sep 20, 2021
PlantCV4 automation moved this from In progress to Done Sep 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature New feature ideas and solutions ready to review
Projects
PlantCV4
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants