https://github.com/cytoscape/cy-community-detection
Community Detection App for Cytoscape
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 2 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.1%) to scientific vocabulary
Keywords from Contributors
Repository
Community Detection App for Cytoscape
Basic Info
Statistics
- Stars: 4
- Watchers: 12
- Forks: 2
- Open Issues: 15
- Releases: 0
Metadata Files
README.md
Community Detection App for Cytoscape
Community Detection App is a Cytoscape App that leverages third party algorithms (via REST service) to perform hierarchical clustering/community detection on a given network. Leveraging the REST service allows incorporation of algorithms not easily portable/distributable with this App. In addition, this tool offers for biologists Term Mapping/Enrichment (also via service) on the hierarchies generated by this App.
NOTE: This service is experimental. The interface is subject to change.
If you use Community Detection App or REST Service in your research, please cite:
Singhal A, Cao S, Churas C, Pratt D, Fortunato S, Zheng F, et al. (2020) Multiscale community detection in Cytoscape. PLoS Comput Biol 16(10): e1008239. https://doi.org/10.1371/journal.pcbi.1008239
Requirements to use
- Cytoscape 3.7 or above
- Internet connection to allow App to connect to remote services
Installation via from Cytoscape
CDAPS is in the Cytoscape App Store and can be installed by following these instructions
Requirements to build (for developers)
To build documentation
- Make
- Python 3+
- Sphinx (install via
pip install sphinx) - Sphinx rtd theme (install via
pip install sphinx_rtd_theme)
Building manually
Commands below assume Git command line tools have been installed
```Bash
Can also just download repo and unzip it
git clone https://github.com/cytoscape/cy-community-detection
cd cy-community-detection mvn clean test install ```
The above command will create a jar file under target/ named cy-community-detection-<VERSION>.jar that can be installed into Cytoscape
Open Cytoscape and follow instructions here and click on Install from File... button to load the jar created above.
Building documentation
Documentation is stored under docs/ directory and
uses Sphinx & Python to generate documentation that
is auto uploaded from master branch to Read the Docs
```Bash
The clone and directory change can be
omitted if done above
git clone https://github.com/cytoscape/cy-community-detection
cd cy-community-detection
make docs
``
Oncemake docsis run the documentation should automatically
be displayed in default browser, but if not opendocs/_build/html/index.html` in
a web browser
To add dropshadow and border to images, Image Magick has been used with the following command:
Bash
convert foo.png -shave 1x1 -bordercolor black -border 1 \
( +clone -background gray -shadow 80x3+5+5 ) +swap \
-background none -layers merge +repage foo_fixed.png
COPYRIGHT AND LICENSE
Acknowledgements
- TODO denote funding sources
Owner
- Name: Cytoscape Consortium
- Login: cytoscape
- Kind: organization
- Website: http://www.cytoscape.org/
- Repositories: 153
- Profile: https://github.com/cytoscape
GitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Committers
Last synced: 12 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Chris Churas | c****a@g****m | 266 |
| Akshat Singhal | a****l@u****u | 28 |
| D Otasek | d****v@g****m | 2 |
| dependabot[bot] | 4****] | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
Dependencies
- org.cytoscape:core-task-api 3.7.1 provided
- org.cytoscape:group-api 3.7.1 provided
- org.cytoscape:layout-api 3.7.1 provided
- org.cytoscape:property-api 3.7.1 provided
- org.cytoscape:swing-application-api 3.7.1 provided
- org.cytoscape:work-api 3.7.1 provided
- org.ops4j.pax.logging:pax-logging-api 1.11.12 provided
- org.osgi:org.osgi.core 6.0.0 provided
- com.fasterxml.jackson.core:jackson-databind 2.10.5.1
- com.fasterxml.jackson.jaxrs:jackson-jaxrs-base 2.10.1
- com.google.code.gson:gson 2.8.5
- org.apache.httpcomponents:httpclient 4.5.9
- org.apache.httpcomponents:httpmime 4.5.9
- org.cytoscape:io-api 3.7.1
- org.cytoscape:model-api 3.7.1
- org.cytoscape:service-api 3.7.1
- org.ndexbio.communitydetection.rest.model:communitydetection-rest-model 1.0.0
- org.ndexbio:ndex-object-model 2.5.0-20200508.163437-2
- junit:junit 4.12 test
- org.cytoscape:event-api 3.7.1 test
- org.cytoscape:model-impl 3.7.1 test
- org.mockito:mockito-core 3.2.4 test