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

Joss prereview #142

Merged
merged 3 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
^Meta$
^codecov\.yml$
^paper
CONTRIBUTING.md
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
### Contribute to the Software

There are many ways to contribute to ggoncoplot.

1. Request features you would like to by [creating new issues on
github](https://github.com/selkamand/ggoncoplot/issues)
2. [Make your visualisation packages ggoncoplot-compatible]
3. [Directly contribute to the ggoncoplot codebase]

#### Make your visualisation packages ggoncoplot-compatible

If your package produces ggplots that you would like to interactively
link with ggoncoplot, consider converting your geoms to their ggiraph
interactive equivalents and adding a data_id based on a sample
identifier column in the dataset. That way end-users can create a
data-linked oncoplot composed with your packages plots using patchwork
([example](https://selkamand.github.io/ggoncoplot/articles/manual.html#interaction-with-other-packages))

#### Directly contribute to the ggoncoplot codebase

We welcome contributions from the community to enhance and expand the
functionality of `ggoncoplot`. Whether you want to fix a bug, add new
features, improve documentation, or optimize performance, your efforts
are highly valued. To get started:

1. **Fork the Repository**: Click on the 'Fork' button at the top right
of this page to create a copy of the repository in your GitHub
account.

2. **Clone the Repository**: Use `git clone` to clone your forked
repository to your local machine.

``` bash
git clone https://github.com/selkamand/ggoncoplot.git
```

3. **Create a Branch**

``` bash
git checkout -b feature-name
```

4. **Make Changes**: Implement your changes in the new branch

5. **Commit and Push**: Commit your changes and push the branch to your
forked repository.

6. **Create a Pull Request**: Go to the original repository and open a
pull request from your branch. Please provide a clear description of
your changes and any relevant issues or discussions.

### Report Issues or Problems with the Software

If you encounter any issues, bugs, or have suggestions for improvements,
please report them using the [GitHub Issues Tab](https://github.com/selkamand/ggoncoplot/issues/).

### Seek Support

For any questions or support regarding the use of ggoncoplot you can:

- **Check the Documentation**: Comprehensive documentation is
available [here](https://selkamand.github.io/ggoncoplot/index.html).

- **Create a** [new
issue](https://github.com/selkamand/ggoncoplot/issues/new) with your
query.

- **Browse Existing Issues**: Check the
[Issues](https://github.com/selkamand/ggoncoplot/issues) page to see
if your query has been addressed.

- **Contact Us**: If you need direct assistance, please [contact the
maintainers
directly](mailto:[email protected]?subject=ggoncoplot)
74 changes: 1 addition & 73 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -140,77 +140,5 @@ during the early stages of ggoncoplot development.

## Community Contributions

### Contribute to the Software
All types of contributions are encouraged and valued. See our [guide to community contributions](CONTRIBUTING.md) for different ways to help.

There are many ways to contribute to ggoncoplot.

1. Request features you would like to by [creating new issues on
github](https://github.com/selkamand/ggoncoplot/issues)
2. [Make your visualisation packages ggoncoplot-compatible]
3. [Directly contribute to the ggoncoplot codebase]

#### Make your visualisation packages ggoncoplot-compatible

If your package produces ggplots that you would like to interactively
link with ggoncoplot, consider converting your geoms to their ggiraph
interactive equivalents and adding a data_id based on a sample
identifier column in the dataset. That way end-users can create a
data-linked oncoplot composed with your packages plots using patchwork
([example](https://selkamand.github.io/ggoncoplot/articles/manual.html#interaction-with-other-packages))

#### Directly contribute to the ggoncoplot codebase

We welcome contributions from the community to enhance and expand the
functionality of `ggoncoplot`. Whether you want to fix a bug, add new
features, improve documentation, or optimize performance, your efforts
are highly valued. To get started:

1. **Fork the Repository**: Click on the 'Fork' button at the top right
of this page to create a copy of the repository in your GitHub
account.

2. **Clone the Repository**: Use `git clone` to clone your forked
repository to your local machine.

``` bash
git clone https://github.com/selkamand/ggoncoplot.git
```

3. **Create a Branch**

``` bash
git checkout -b feature-name
```

4. **Make Changes**: Implement your changes in the new branch

5. **Commit and Push**: Commit your changes and push the branch to your
forked repository.

6. **Create a Pull Request**: Go to the original repository and open a
pull request from your branch. Please provide a clear description of
your changes and any relevant issues or discussions.

### Report Issues or Problems with the Software

If you encounter any issues, bugs, or have suggestions for improvements,
please report them using the [GitHub Issues Tab](https://github.com/selkamand/ggoncoplot/issues/).

### Seek Support

For any questions or support regarding the use of ggoncoplot you can:

- **Check the Documentation**: Comprehensive documentation is
available [here](https://selkamand.github.io/ggoncoplot/index.html).

- **Create a** [new
issue](https://github.com/selkamand/ggoncoplot/issues/new) with your
query.

- **Browse Existing Issues**: Check the
[Issues](https://github.com/selkamand/ggoncoplot/issues) page to see
if your query has been addressed.

- **Contact Us**: If you need direct assistance, please [contact the
maintainers
directly](mailto:[email protected]?subject=ggoncoplot)
78 changes: 2 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,79 +172,5 @@ during the early stages of ggoncoplot development.

## Community Contributions

### Contribute to the Software

There are many ways to contribute to ggoncoplot.

1. Request features you would like to by [creating new issues on
github](https://github.com/selkamand/ggoncoplot/issues)
2. [Make your visualisation packages
ggoncoplot-compatible](#make-your-visualisation-packages-ggoncoplot-compatible)
3. [Directly contribute to the ggoncoplot
codebase](#directly-contribute-to-the-ggoncoplot-codebase)

#### Make your visualisation packages ggoncoplot-compatible

If your package produces ggplots that you would like to interactively
link with ggoncoplot, consider converting your geoms to their ggiraph
interactive equivalents and adding a data_id based on a sample
identifier column in the dataset. That way end-users can create a
data-linked oncoplot composed with your packages plots using patchwork
([example](https://selkamand.github.io/ggoncoplot/articles/manual.html#interaction-with-other-packages))

#### Directly contribute to the ggoncoplot codebase

We welcome contributions from the community to enhance and expand the
functionality of `ggoncoplot`. Whether you want to fix a bug, add new
features, improve documentation, or optimize performance, your efforts
are highly valued. To get started:

1. **Fork the Repository**: Click on the ‘Fork’ button at the top right
of this page to create a copy of the repository in your GitHub
account.

2. **Clone the Repository**: Use `git clone` to clone your forked
repository to your local machine.

``` bash
git clone https://github.com/selkamand/ggoncoplot.git
```

3. **Create a Branch**

``` bash
git checkout -b feature-name
```

4. **Make Changes**: Implement your changes in the new branch

5. **Commit and Push**: Commit your changes and push the branch to your
forked repository.

6. **Create a Pull Request**: Go to the original repository and open a
pull request from your branch. Please provide a clear description of
your changes and any relevant issues or discussions.

### Report Issues or Problems with the Software

If you encounter any issues, bugs, or have suggestions for improvements,
please report them using the [GitHub Issues
Tab](https://github.com/selkamand/ggoncoplot/issues/).

### Seek Support

For any questions or support regarding the use of ggoncoplot you can:

- **Check the Documentation**: Comprehensive documentation is available
[here](https://selkamand.github.io/ggoncoplot/index.html).

- **Create a** [new
issue](https://github.com/selkamand/ggoncoplot/issues/new) with your
query.

- **Browse Existing Issues**: Check the
[Issues](https://github.com/selkamand/ggoncoplot/issues) page to see
if your query has been addressed.

- **Contact Us**: If you need direct assistance, please [contact the
maintainers directly](mailto:[email protected]?subject=ggoncoplot)
All types of contributions are encouraged and valued. See our [guide to
community contributions](CONTRIBUTING.md) for different ways to help.
3 changes: 3 additions & 0 deletions paper/jats/paper.jats
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ a Creative Commons Attribution 4.0 International License (CC BY
<article-title>Ggiraph: Make ’ggplot2’ graphics interactive</article-title>
<year iso-8601-date="2024">2024</year>
<uri>https://davidgohel.github.io/ggiraph/</uri>
<pub-id pub-id-type="doi">10.32614/CRAN.package.ggiraph</pub-id>
</element-citation>
</ref>
<ref id="ref-pedersenU003A2024">
Expand All @@ -323,6 +324,7 @@ a Creative Commons Attribution 4.0 International License (CC BY
<article-title>Patchwork: The composer of plots</article-title>
<year iso-8601-date="2024">2024</year>
<uri>https://patchwork.data-imaginist.com</uri>
<pub-id pub-id-type="doi">10.32614/cran.package.patchwork</pub-id>
</element-citation>
</ref>
<ref id="ref-wickhamU003A2016">
Expand All @@ -335,6 +337,7 @@ a Creative Commons Attribution 4.0 International License (CC BY
<year iso-8601-date="2016">2016</year>
<isbn>978-3-319-24277-4</isbn>
<uri>https://ggplot2.tidyverse.org</uri>
<pub-id pub-id-type="doi">10.32614/CRAN.package.ggplot2</pub-id>
</element-citation>
</ref>
<ref id="ref-goldmanU003A2020">
Expand Down
7 changes: 5 additions & 2 deletions paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,17 @@ @misc{gohel:2024
author = {David Gohel and Panagiotis Skintzos},
year = {2024},
note = {R package version 0.8.10},
url = {https://davidgohel.github.io/ggiraph/}
url = {https://davidgohel.github.io/ggiraph/},
doi = {10.32614/CRAN.package.ggiraph}
}

@misc{pedersen:2024,
title = {patchwork: The Composer of Plots},
author = {Thomas Lin Pedersen},
year = {2024},
note = {R package version 1.2.0.9000},
url = {https://patchwork.data-imaginist.com}
url = {https://patchwork.data-imaginist.com},
doi = {10.32614/cran.package.patchwork}
}

@Book{wickham:2016,
Expand All @@ -63,6 +65,7 @@ @Book{wickham:2016
year = {2016},
isbn = {978-3-319-24277-4},
url = {https://ggplot2.tidyverse.org},
doi = {10.32614/CRAN.package.ggplot2}
}


Expand Down
Binary file modified paper/paper.pdf
Binary file not shown.
Loading