RCy3
New version of RCy3, redesigned and collaboratively maintained by Cytoscape developer community
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
9 of 29 committers (31.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.3%) to scientific vocabulary
Keywords from Contributors
Repository
New version of RCy3, redesigned and collaboratively maintained by Cytoscape developer community
Basic Info
Statistics
- Stars: 52
- Watchers: 19
- Forks: 20
- Open Issues: 5
- Releases: 1
Metadata Files
README.md
Welcome to RCy3: 2.0 and Beyond
- Bioconductor Release Build
- Bioconductor Dev Build
- GitHub Dev Build by Travis
Building upon the phenominal success of RCytoscape and RCy3, Cytoscape is adopting this project to provide a robust R package for the rapidly evolving Cytoscape ecosystem. We are beginning with a major refactor of RCy3 that includes:
- independence from the graphNEL object model
- harmonized function and argument names
- support for Cytoscape commands
- better support for Cytoscape apps
- see NEWS for the complete release notes
- coordinated development with CyREST and the Cytoscape service model
- coordinated development with other scripting libraries, e.g.,
Getting Started
How to install
Official bioconductor releases (recommended)
install.packages("BiocManager")
BiocManager::install("RCy3")
Note: Be sure to use the latest Bioconductor and recommended R version
Development version from this repo (at your own risk) ``` install.packages("devtools") library(devtools) installgithub('cytoscape/RCy3', buildvignettes=FALSE)
If installation fails due to package 'XXX' not found,
then run install.packages("XXX") and then try install_github('cytoscape/RCy3') again
library(RCy3) ```
Troubleshooting
- If you see this error on a Mac:
make: gfortran-4.8: No such file or directory, then try reinstalling R via homebrew:brew update && brew reinstall r- warning: this may take ~30 minutes
- If you see this error in RStudio:
ERROR: dependency ‘XML’ is not available for package, then try this command:install.packages("XML")and then try installing RCy3 again.
How to contribute
This is a public, open source project. Come on in! You can contribute at multiple levels:
- Report an issue or feature request
- Fork and make pull requests
- Contact current Cytoscape developers and inquire about joining the team
Development
``` install.packages("devtools")
install.packages("roxygen2") library(devtools,roxygen2) devtools::install_github("AlexanderPico/docthis") library(docthis) #shift+cmd+D BiocManager::install("BiocStyle") library(BiocStyle) BiocManager::install("BiocCheck") library(BiocCheck) install.packages("RUnit") library(RUnit) setwd("/git/cytoscape/RCy3") #customize to your setup devtools::document() devtools::check(args = "--no-examples", vignettes = F) BiocCheck::BiocCheck('./') ```
Testing
Unit tests are a crucial tool in software development. In order to run them 'offline' (not on the Bioconductor build system), take these steps from within a running R session (requires RUnit):
source(system.file("unitTests", "test_RCy3.R", package="RCy3"))
run.tests()
They take about 4 minutes to run.
Updating site
We use pkgdown to generate the main site for RCy3 based on this README, metadata, man pages and vignettes. If you make changes to any of these, please take a moment to regenerate the site:
library(pkgdown)
pkgdown::build_site(examples=FALSE)
Bioconductor
While this is the primary development repository for the RCy3 project, we also make regular pushes to official bioconductor repository (devel & release) from which the official releases are generated. This is the correct repo for all coding and bug reporting interests. The tagged releases here correspond to the bioconductor releases via a manual syncing process. The devel branch here corresponds to the latest code in development and not yet released.
git commit -m "informative commit message"
git push origin devel
git push upstream devel
http://bioconductor.org/developers/how-to/git/push-to-github-bioc/
Following each bioconductor release, a RELEASE_#_# branch is created. The new branch is fetched and devel is updated:
git fetch upstream
git checkout -b RELEASE_3_13 upstream/RELEASE_3_13
git push origin RELEASE_3_13
git checkout devel
git pull upstream devel
git push origin devel
Only bug fixes and documentation updates can be pushed to the official bioconductor release branch. After committing and pushing fixes to devel, then:
``` git checkout RELEASE313 git cherry-pick devel #for lastest commit
or git cherry-pick 1abc234 #for specific commit
or git cherry-pick 1abc234^..5def678 #for an inclusive range
bump release version in DESCRIPTION
git commit -am 'version bump' git push origin RELEASE313
double check changes, and then...
git push upstream RELEASE313 git checkout devel
bump dev version in DESCRIPTION
git commit -am 'version bump' git push origin devel git push upstream devel ```
https://bioconductor.org/developers/how-to/git/bug-fix-in-release-and-devel/
Vignettes
When adding or updating vignettes, consider the following tips for consistency: * Copy/paste the header from an existing RCy3 vignette, including the global knitr options * Number the VignetteIndexEntry names w.r.t. other vignettes (this determines their presentation order) * Avoid spaces in Rmd filenames; causes CHECK errors * When ready, run Knit to html_document and review the generated html (requires BiocStyle) * Note: you don't need to save the html version; it will be generated anew at Bioconductor. * In the end, you should just have an Rmd version of each vignette in the repo.
Former Repo
The entire commit history has been preserved during this transition, but you can find the repo for RCy3 v1.5.3 and earlier at https://github.com/tmuetze/BioconductorRCy3thenewRCytoscape and you can find the Bioconductor page for v1.8.0, including archives at https://www.bioconductor.org/packages/3.6/bioc/html/RCy3.html.
Note to repository maintainers: Please *DO NOT* move this page ... the Cytoscape Automation paper refers directly to it.
Owner
- Name: Cytoscape Consortium
- Login: cytoscape
- Kind: organization
- Website: http://www.cytoscape.org/
- Repositories: 153
- Profile: https://github.com/cytoscape
GitHub Events
Total
- Issues event: 12
- Watch event: 5
- Issue comment event: 17
- Push event: 7
- Create event: 2
Last Year
- Issues event: 12
- Watch event: 5
- Issue comment event: 17
- Push event: 7
- Create event: 2
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Tanja | t****e | 1,118 |
| Alexander Pico | a****o@g****u | 645 |
| Yihang Xin | y****n@L****l | 446 |
| Tanja | t****4@i****k | 385 |
| Yihang Xin | y****n@g****u | 289 |
| tmuetze | t****e@g****m | 67 |
| GeorgiKoli | g****i@g****m | 53 |
| Julia Gustavsen | j****n@g****m | 37 |
| Yihang Xin | 4****x | 23 |
| Nitesh Turaga | n****a@g****m | 14 |
| J Wokaty | j****y@s****u | 10 |
| Dan Tenenbaum | d****a@f****g | 9 |
| Kristina Hanspers | k****s@g****u | 7 |
| Herve Pages | h****s@f****g | 4 |
| spa23 | s****y@y****u | 2 |
| A Wokaty | a****y@s****u | 2 |
| vobencha | v****n@r****g | 2 |
| Barry Demchak | i****k@g****m | 2 |
| Robert M Flight | r****9@g****m | 2 |
| pshannon-bioc | p****n@f****g | 2 |
| vobencha | v****a@g****m | 2 |
| Hervé Pagès | h****s@f****g | 2 |
| m-grimes | m****s@m****u | 1 |
| meetagrawal09 | a****1@g****m | 1 |
| Kozo Nishida | k****a@g****m | 1 |
| Diego Diez | d****z@g****m | 1 |
| James Hester | j****r@f****g | 1 |
| Joris | j****e@w****l | 1 |
| De | d****r@m****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 104
- Total pull requests: 5
- Average time to close issues: 3 months
- Average time to close pull requests: 14 days
- Total issue authors: 39
- Total pull request authors: 5
- Average comments per issue: 2.33
- Average comments per pull request: 0.4
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 6
- Pull requests: 0
- Average time to close issues: 4 days
- Average time to close pull requests: N/A
- Issue authors: 6
- Pull request authors: 0
- Average comments per issue: 2.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- AlexanderPico (48)
- m-grimes (7)
- kozo2 (6)
- ariutta (5)
- risserlin (3)
- methornton (2)
- vttrifonov (2)
- bdemchak (2)
- zcsharp101 (2)
- kkami1115 (1)
- saeedfc (1)
- shraddhapai (1)
- shagupta13 (1)
- eagomezc (1)
- sshechte (1)
Pull Request Authors
- AlexanderPico (1)
- jooolia (1)
- rmflight (1)
- Jorisvansteenbrugge (1)
- kozo2 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- bioconductor 99,258 total
- Total dependent packages: 15
- Total dependent repositories: 0
- Total versions: 6
- Total maintainers: 1
bioconductor.org: RCy3
Functions to Access and Control Cytoscape
- Homepage: https://github.com/cytoscape/RCy3
- Documentation: https://bioconductor.org/packages/release/bioc/vignettes/RCy3/inst/doc/RCy3.pdf
- License: MIT + file LICENSE
-
Latest release: 2.28.1
published 12 months ago
Rankings
Maintainers (1)
Dependencies
- BiocGenerics * imports
- IRdisplay * imports
- IRkernel * imports
- RColorBrewer * imports
- RCurl * imports
- RJSONIO * imports
- XML * imports
- base64enc * imports
- base64url * imports
- fs * imports
- glue * imports
- gplots * imports
- graph * imports
- httr * imports
- methods * imports
- stats * imports
- uchardet * imports
- utils * imports
- uuid * imports
- BiocStyle * suggests
- grDevices * suggests
- igraph * suggests
- knitr * suggests
- rmarkdown * suggests