Skip to content

Commit 50339a0

Browse files
committed
Added installation instructions for Cytoscape to readme
1 parent bc78a83 commit 50339a0

File tree

3 files changed

+41
-9
lines changed

3 files changed

+41
-9
lines changed

CITATION.cff

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ message: "If you use this software, please cite it as below."
33
authors:
44
- family-names: Visser
55
given-names: Ronald
6-
orcid: "https://orcid.org/0000-0001-6966-1729"
6+
orcid: https://orcid.org/0000-0001-6966-1729
77
title: "dendroNetwork: a R-package to create dendrochronological networks"
88
version: 0.5.1
99
doi: https://zenodo.org/doi/10.5281/zenodo.10636310

README.Rmd

+9-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@ bibliography: references.bib
44
csl: journal-of-computer-applications-in-archaeology.csl
55
---
66

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

99
<!-- badges: start -->
1010

11-
[![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)
12-
[![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/627_status.svg)](https://github.com/ropensci/software-review/issues/627)
13-
[![DOI](https://zenodo.org/badge/582742098.svg)](https://zenodo.org/doi/10.5281/zenodo.10636310)
11+
[![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)
1412

1513
<!-- badges: end -->
1614

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

2725
## Installation
2826

29-
This package depends on RCy3, which is part of Bioconductor. Therefore it is recommended to install RCy3 first using:
27+
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:
3028

3129
``` r
3230
if (!require("BiocManager", quietly = TRUE))
@@ -35,6 +33,8 @@ if (!require("BiocManager", quietly = TRUE))
3533
BiocManager::install("RCy3")
3634
```
3735

36+
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/>.
37+
3838
You can install the development version of dendroNetwork from [GitHub](https://github.com/RonaldVisser/DendroNetwork) with:
3939

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

129129
## Citation
130130

131+
```{r citation}
132+
citation("dendroNetwork")
133+
```
134+
131135
If you use this software, please cite this using:
132136

133137
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>

README.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

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

44
<!-- badges: start -->
55

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

2525
## Installation
2626

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

3032
``` r
3133
if (!require("BiocManager", quietly = TRUE))
@@ -34,6 +36,11 @@ if (!require("BiocManager", quietly = TRUE))
3436
BiocManager::install("RCy3")
3537
```
3638

39+
The functionaliy of RCy3 depends on the installation of Cytoscape. It is
40+
therefore recommended to install Cyscape as well. Please follow the
41+
download and installation instructions for your operating system:
42+
<https://cytoscape.org/>.
43+
3744
You can install the development version of dendroNetwork from
3845
[GitHub](https://github.com/RonaldVisser/DendroNetwork) with:
3946

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

147154
## Citation
148155

156+
``` r
157+
citation("dendroNetwork")
158+
#> Warning in citation("dendroNetwork"): could not determine year for
159+
#> 'dendroNetwork' from package DESCRIPTION file
160+
#> To cite package 'dendroNetwork' in publications use:
161+
#>
162+
#> Visser R (????). _dendroNetwork: Create networks of
163+
#> dendrochronological series using pairwise similarity_. R package
164+
#> version 0.5.2, https://ronaldvisser.github.io/dendroNetwork/,
165+
#> <https://github.com/RonaldVisser/dendroNetwork>.
166+
#>
167+
#> A BibTeX entry for LaTeX users is
168+
#>
169+
#> @Manual{,
170+
#> title = {dendroNetwork: Create networks of dendrochronological series using pairwise similarity},
171+
#> author = {Ronald Visser},
172+
#> note = {R package version 0.5.2, https://ronaldvisser.github.io/dendroNetwork/},
173+
#> url = {https://github.com/RonaldVisser/dendroNetwork},
174+
#> }
175+
```
176+
149177
If you use this software, please cite this using:
150178

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

0 commit comments

Comments
 (0)