Skip to content

Commit

Permalink
transfer to ropensci
Browse files Browse the repository at this point in the history
- modify links to the repository
- remove code of conduct
- remove pkgdown webpage and use the docs.ropensci
  • Loading branch information
giovsaraceno committed Feb 3, 2025
1 parent 3c699ca commit 3a429ce
Show file tree
Hide file tree
Showing 7 changed files with 203 additions and 469 deletions.
48 changes: 0 additions & 48 deletions .github/workflows/pkgdown.yaml

This file was deleted.

74 changes: 0 additions & 74 deletions CODE_OF_CONDUCT.md

This file was deleted.

6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Description: It includes test for multivariate normality, test for uniformity on
and Golzy, M. and Markatou, M. (2020) <doi:10.1080/10618600.2020.1740713>.
License: GPL (>= 3)
URL: https://CRAN.R-project.org/package=QuadratiK,
https://github.com/giovsaraceno/QuadratiK-package,
https://giovsaraceno.github.io/QuadratiK-package/
BugReports: https://github.com/giovsaraceno/QuadratiK-package/issues
https://github.com/ropensci/QuadratiK-package,
https://docs.ropensci.org/QuadratiK-package/
BugReports: https://github.com/ropensci/QuadratiK-package/issues
Depends:
R (>= 3.5.0)
Imports:
Expand Down
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

| Usage | Release | Development |
|------------------|------------------------|------------------------------|
| [![CRAN_Downloads_Badge](https://cranlogs.r-pkg.org/badges/grand-total/QuadratiK)](https://cran.r-project.org/package=QuadratiK) [![License: GPL v3](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://giovsaraceno.github.io/QuadratiK-package/LICENSE.html)|[![arXiv](https://img.shields.io/badge/doi-arXiv:2402.02290v2-green.svg)](https://doi.org/10.48550/arXiv.2402.02290) [![CRAN version](https://www.r-pkg.org/badges/version/QuadratiK)](https://CRAN.R-project.org/package=QuadratiK) [![GitHub version](https://img.shields.io/badge/devel%20version-1.1.3-blue.svg)](https://github.com/giovsaraceno/QuadratiK-package) | [![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) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/632_status.svg)](https://github.com/ropensci/software-review/issues/632) [![codecov](https://codecov.io/github/giovsaraceno/QuadratiK-package/graph/badge.svg?token=M4CDTQPONE)](https://app.codecov.io/github/giovsaraceno/QuadratiK-package) [![R-CMD-check](https://github.com/giovsaraceno/QuadratiK-package/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/giovsaraceno/QuadratiK-package/actions/workflows/R-CMD-check.yaml) [![Lifecycle](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) | |
| [![CRAN_Downloads_Badge](https://cranlogs.r-pkg.org/badges/grand-total/QuadratiK)](https://cran.r-project.org/package=QuadratiK) [![License: GPL v3](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://docs.ropensci.org/QuadratiK-package/LICENSE.html)|[![arXiv](https://img.shields.io/badge/doi-arXiv:2402.02290v2-green.svg)](https://doi.org/10.48550/arXiv.2402.02290) [![CRAN version](https://www.r-pkg.org/badges/version/QuadratiK)](https://CRAN.R-project.org/package=QuadratiK) [![GitHub version](https://img.shields.io/badge/devel%20version-1.1.3-blue.svg)](https://github.com/ropensci/QuadratiK-package) | [![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) [![Status at rOpenSci Software Peer Review](https://badges.ropensci.org/632_status.svg)](https://github.com/ropensci/software-review/issues/632) [![codecov](https://codecov.io/github/ropensci/QuadratiK-package/graph/badge.svg?token=M4CDTQPONE)](https://app.codecov.io/github/ropensci/QuadratiK-package) [![R-CMD-check](https://github.com/ropensci/QuadratiK-package/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/QuadratiK-package/actions/workflows/R-CMD-check.yaml) [![Lifecycle](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) | |

<!-- badges: end -->

Expand All @@ -19,7 +19,7 @@ Expanded capabilities include supporting tests for uniformity on the *d*-dimensi

- **Additional Features**: Alongside these functionalities, the software includes additional graphical functions, aiding users in validating and representing the cluster results as well as enhancing the interpretability and usability of the analysis.

For an introduction to the usage of `QuadratiK` see the vignette [Introduction to the QuadratiK Package](https://giovsaraceno.github.io/QuadratiK-package/articles/Introduction.html).
For an introduction to the usage of `QuadratiK` see the vignette [Introduction to the QuadratiK Package](https://docs.ropensci.org/QuadratiK-package/articles/Introduction.html).

## Installation

Expand All @@ -29,25 +29,28 @@ You can install the version published on CRAN of `QuadratiK`
install.packages("QuadratiK")
```

or the development version on GitHub
or the development version from GitHub

``` r
library(devtools)
install_github('giovsaraceno/QuadratiK-package')
# or via the rOpenSci organization repository
install.packages("QuadratiK", repos = "https://ropensci.r-universe.dev")
```

The `QuadratiK` package is also available in Python on PyPI <https://pypi.org/project/QuadratiK/> and also as a Dashboard application. Usage instruction for the Dashboard can be found at <https://quadratik.readthedocs.io/en/latest/user_guide/dashboard_application_usage.html>.

## Authors

Giovanni Saraceno, Marianthi Markatou, Raktim Mukhopadhyay, Mojgan Golzy\
Maintainer: Giovanni Saraceno \<[gsaracen\@buffalo.edu](mailto:[email protected])\>
Maintainer: Giovanni Saraceno \<[giovanni.saraceno\@unipd.it](mailto:[email protected])\>


## Citation

If you use this package in your research or work, please cite it as follows:

Saraceno, G., Markatou, M., Mukhopadhyay, R. and Golzy, M. (2024). QuadratiK: Collection of Methods Constructed using Kernel-Based Quadratic Distances. <https://cran.r-project.org/package=QuadratiK>, <https://github.com/giovsaraceno/QuadratiK-package>, <https://giovsaraceno.github.io/QuadratiK-package/>.
Saraceno, G., Markatou, M., Mukhopadhyay, R. and Golzy, M. (2024). QuadratiK: Collection of Methods Constructed using Kernel-Based Quadratic Distances. <https://cran.r-project.org/package=QuadratiK>, <https://github.com/ropensci/QuadratiK-package>, <https://docs.ropensci.org/QuadratiK-package/>.

```
@Manual{saraceno2024QuadratiK,
Expand All @@ -57,8 +60,8 @@ Saraceno, G., Markatou, M., Mukhopadhyay, R. and Golzy, M. (2024). QuadratiK: Co
and Mojgan Golzy},
year = {2024},
note = {<https://cran.r-project.org/package=QuadratiK>,
<https://github.com/giovsaraceno/QuadratiK-package>,
<https://giovsaraceno.github.io/QuadratiK-package/>},
<https://github.com/ropensci/QuadratiK-package>,
<https://docs.ropensci.org/QuadratiK-package/>},
}
```

Expand Down Expand Up @@ -90,3 +93,5 @@ Saraceno, G., Markatou, M., Mukhopadhyay, R. and Golzy, M. (2024). Goodness-of-F
## Details

The work has been supported by Kaleida Health Foundation and National Science Foundation.

Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.
5 changes: 3 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
url: ~
template:
bootstrap: 5
template:
params: {}


Loading

0 comments on commit 3a429ce

Please sign in to comment.