Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qddyy committed Jun 6, 2024
1 parent 344847a commit ff72f1c
Show file tree
Hide file tree
Showing 17 changed files with 384 additions and 379 deletions.
10 changes: 7 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,23 @@ options(

## Overview

This package implements some of the non-parametric tests in chapters 1-5 of [@Higgins2003](#references).
This R package implements some of the non-parametric tests in chapters 1-5 of [@Higgins2003](#references).

It depends on [R6](https://CRAN.R-project.org/package=R6) for object oriented design and [Rcpp](https://CRAN.R-project.org/package=Rcpp) for integration of R and C++.

A few examples in the book can be found [here](https://qddyy.github.io/LearnNonparam/articles/examples).

## Installation

For the latest bug fixes and improvements, please install the development version of this R package using

```{r, install, eval = FALSE}
# install.packages("pak")
pak::pkg_install("qddyy/LearnNonparam")
# install.packages("remotes")
remotes::install_github("qddyy/LearnNonparam")
```

Feedback and contributions are welcome. Please feel free to report bugs or request new features by opening an issue.

## Usage

```{r, library, eval = FALSE}
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ check](https://github.com/qddyy/LearnNonparam/actions/workflows/R-CMD-check.yaml

## Overview

This package implements some of the non-parametric tests in chapters 1-5
of [Higgins (2003)](#references).
This R package implements some of the non-parametric tests in chapters
1-5 of [Higgins (2003)](#references).

It depends on [R6](https://CRAN.R-project.org/package=R6) for object
oriented design and [Rcpp](https://CRAN.R-project.org/package=Rcpp) for
Expand All @@ -26,11 +26,17 @@ A few examples in the book can be found

## Installation

For the latest bug fixes and improvements, please install the
development version of this R package using

``` r
# install.packages("pak")
pak::pkg_install("qddyy/LearnNonparam")
# install.packages("remotes")
remotes::install_github("qddyy/LearnNonparam")
```

Feedback and contributions are welcome. Please feel free to report bugs
or request new features by opening an issue.

## Usage

``` r
Expand Down
2 changes: 1 addition & 1 deletion man/figures/README/define-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion man/figures/README/define.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
711 changes: 353 additions & 358 deletions man/figures/README/ggplot.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion man/figures/README/modify-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion man/figures/README/modify.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion man/figures/README/p_value-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion man/figures/README/p_value.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ff72f1c

Please sign in to comment.