Skip to content

Commit

Permalink
Added installation instructions for Cytoscape to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RonaldVisser committed Mar 29, 2024
1 parent bc78a83 commit 50339a0
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ message: "If you use this software, please cite it as below."
authors:
- family-names: Visser
given-names: Ronald
orcid: "https://orcid.org/0000-0001-6966-1729"
orcid: https://orcid.org/0000-0001-6966-1729
title: "dendroNetwork: a R-package to create dendrochronological networks"
version: 0.5.1
doi: https://zenodo.org/doi/10.5281/zenodo.10636310
Expand Down
14 changes: 9 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@ bibliography: references.bib
csl: journal-of-computer-applications-in-archaeology.csl
---

# dendroNetwork <img src="man/figures/dendroNetwork_hexsticker.png" align="right" height="200" style="float:right; height:200px;">
# dendroNetwork <img src="man/figures/dendroNetwork_hexsticker.png" align="right" height="200" style="float:right; height:200px;"/>

<!-- badges: start -->

[![Project Status: Active -- The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![pkgcheck](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/pkgcheck.yaml/badge.svg)](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/pkgcheck.yaml) [![R-CMD-check](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/R-CMD-check.yaml)
[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/627_status.svg)](https://github.com/ropensci/software-review/issues/627)
[![DOI](https://zenodo.org/badge/582742098.svg)](https://zenodo.org/doi/10.5281/zenodo.10636310)
[![Project Status: Active -- The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![pkgcheck](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/pkgcheck.yaml/badge.svg)](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/pkgcheck.yaml) [![R-CMD-check](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/RonaldVisser/dendroNetwork/actions/workflows/R-CMD-check.yaml) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/627_status.svg)](https://github.com/ropensci/software-review/issues/627) [![DOI](https://zenodo.org/badge/582742098.svg)](https://zenodo.org/doi/10.5281/zenodo.10636310)

<!-- badges: end -->

Expand All @@ -26,7 +24,7 @@ dendroNetwork is a package to create dendrochronological networks for gaining in

## Installation

This package depends on RCy3, which is part of Bioconductor. Therefore it is recommended to install RCy3 first using:
This package depends on [RCy3](https://www.bioconductor.org/packages/release/bioc/html/RCy3.html), which is part of Bioconductor. Therefore it is recommended to install RCy3 first using:

``` r
if (!require("BiocManager", quietly = TRUE))
Expand All @@ -35,6 +33,8 @@ if (!require("BiocManager", quietly = TRUE))
BiocManager::install("RCy3")
```

The functionaliy of RCy3 depends on the installation of Cytoscape. It is therefore recommended to install Cyscape as well. Please follow the download and installation instructions for your operating system: <https://cytoscape.org/>.

You can install the development version of dendroNetwork from [GitHub](https://github.com/RonaldVisser/DendroNetwork) with:

``` r
Expand Down Expand Up @@ -128,6 +128,10 @@ The workflow is similar as above, but with minor changes:

## Citation

```{r citation}
citation("dendroNetwork")
```

If you use this software, please cite this using:

Visser, R. (2024). dendroNetwork: a R-package to create dendrochronological provenance networks (Version 0.5.1) [Computer software]. <https://zenodo.org/doi/10.5281/zenodo.10636310>
Expand Down
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# dendroNetwork <img src="man/figures/dendroNetwork_hexsticker.png" align="right" height="200" style="float:right; height:200px;">
# dendroNetwork <img src="man/figures/dendroNetwork_hexsticker.png" align="right" height="200" style="float:right; height:200px;"/>

<!-- badges: start -->

Expand All @@ -24,8 +24,10 @@ Visser and Vorst 2022)

## Installation

This package depends on RCy3, which is part of Bioconductor. Therefore
it is recommended to install RCy3 first using:
This package depends on
[RCy3](https://www.bioconductor.org/packages/release/bioc/html/RCy3.html),
which is part of Bioconductor. Therefore it is recommended to install
RCy3 first using:

``` r
if (!require("BiocManager", quietly = TRUE))
Expand All @@ -34,6 +36,11 @@ if (!require("BiocManager", quietly = TRUE))
BiocManager::install("RCy3")
```

The functionaliy of RCy3 depends on the installation of Cytoscape. It is
therefore recommended to install Cyscape as well. Please follow the
download and installation instructions for your operating system:
<https://cytoscape.org/>.

You can install the development version of dendroNetwork from
[GitHub](https://github.com/RonaldVisser/DendroNetwork) with:

Expand Down Expand Up @@ -146,6 +153,27 @@ The workflow is similar as above, but with minor changes:

## Citation

``` r
citation("dendroNetwork")
#> Warning in citation("dendroNetwork"): could not determine year for
#> 'dendroNetwork' from package DESCRIPTION file
#> To cite package 'dendroNetwork' in publications use:
#>
#> Visser R (????). _dendroNetwork: Create networks of
#> dendrochronological series using pairwise similarity_. R package
#> version 0.5.2, https://ronaldvisser.github.io/dendroNetwork/,
#> <https://github.com/RonaldVisser/dendroNetwork>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {dendroNetwork: Create networks of dendrochronological series using pairwise similarity},
#> author = {Ronald Visser},
#> note = {R package version 0.5.2, https://ronaldvisser.github.io/dendroNetwork/},
#> url = {https://github.com/RonaldVisser/dendroNetwork},
#> }
```

If you use this software, please cite this using:

Visser, R. (2024). dendroNetwork: a R-package to create
Expand Down

0 comments on commit 50339a0

Please sign in to comment.