Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
smeekes committed May 17, 2024
1 parent 63bbc51 commit 610fa18
Show file tree
Hide file tree
Showing 17 changed files with 125 additions and 5 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
### Miscellaneous
* Added RcppParallel cxxflags to makevars, needed for compatibility with Windows ARM64
* GitHub Actions added
* New package website

## Version 1.0.3

Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The development version of the `bootUR` package can be installed from GitHub usi
# install.packages("devtools")
devtools::install_github("smeekes/bootUR")
```
When installing from GitHub, in order to build the package from source, you need to have the appropriate R development tools installed (such as [Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows.)
When installing from GitHub, in order to build the package from source, you need to have the appropriate R development tools installed ([Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows, or [these tools](https://mac.r-project.org/tools/) on Mac).

If you want the vignette to appear in your package when installing from GitHub, use
```{r install-vign, eval = FALSE}
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ devtools::install_github("smeekes/bootUR")
```

When installing from GitHub, in order to build the package from source,
you need to have the appropriate R development tools installed (such as
[Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows.)
you need to have the appropriate R development tools installed
([Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows, or
[these tools](https://mac.r-project.org/tools/) on Mac).

If you want the vignette to appear in your package when installing from
GitHub, use
Expand Down
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
url: https://smeekes.github.io/bootUR/
template:
bootstrap: 5

bootswatch: spacelab
Binary file added man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon.ico
Binary file not shown.
54 changes: 54 additions & 0 deletions pkgdown/index.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```

# bootUR: Bootstrap Unit Root Tests
<!-- badges: start -->
[![CRAN_Version_Badge](http://www.r-pkg.org/badges/version/bootUR)](https://cran.r-project.org/package=bootUR)
[![CRAN_Downloads_Badge](https://cranlogs.r-pkg.org/badges/grand-total/bootUR)](https://cran.r-project.org/package=bootUR)
[![License_GPLv2_Badge](https://img.shields.io/badge/License-GPLv2-yellow.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
[![License_GPLv3_Badge](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
[![R-CMD-check](https://github.com/smeekes/bootUR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/smeekes/bootUR/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The R package `bootUR` implements several bootstrap tests for unit roots, both for single time series and for (potentially) large systems of time series.

## Installation and Loading
The package can be installed from CRAN using
```{r install-cran, eval = FALSE}
install.packages("bootUR")
```

The development version of the `bootUR` package can be installed from GitHub using
```{r install-github, eval = FALSE}
# install.packages("devtools")
devtools::install_github("smeekes/bootUR")
```
When installing from GitHub, in order to build the package from source, you need to have the appropriate R development tools installed ([Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows, or [these tools](https://mac.r-project.org/tools/) on Mac).

If you want the vignette to appear in your package when installing from GitHub, use
```{r install-vign, eval = FALSE}
# install.packages("devtools")
devtools::install_github("smeekes/bootUR", build_vignettes = TRUE, dependencies = TRUE)
```
instead. As building the vignette may take a bit of time (all bootstrap code below is run), package installation will be slower this way.

After installation, the package can be loaded in the standard way:
```{r load}
library(bootUR)
```

## Functionality
A quick overview of the package functionality is provided in the vignette `vignette("bootUR")`.

A further investigation of the functionalities is provided in the *Journal of Statistical Software* article [bootUR: An R Package for Bootstrap Unit Root Tests ](https://doi.org/10.18637/jss.v106.i12).
64 changes: 64 additions & 0 deletions pkgdown/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# bootUR: Bootstrap Unit Root Tests

<!-- badges: start -->

[![CRAN_Version_Badge](http://www.r-pkg.org/badges/version/bootUR)](https://cran.r-project.org/package=bootUR)
[![CRAN_Downloads_Badge](https://cranlogs.r-pkg.org/badges/grand-total/bootUR)](https://cran.r-project.org/package=bootUR)
[![License_GPLv2_Badge](https://img.shields.io/badge/License-GPLv2-yellow.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
[![License_GPLv3_Badge](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
[![R-CMD-check](https://github.com/smeekes/bootUR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/smeekes/bootUR/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The R package `bootUR` implements several bootstrap tests for unit
roots, both for single time series and for (potentially) large systems
of time series.

## Installation and Loading

The package can be installed from CRAN using

``` r
install.packages("bootUR")
```

The development version of the `bootUR` package can be installed from
GitHub using

``` r
# install.packages("devtools")
devtools::install_github("smeekes/bootUR")
```

When installing from GitHub, in order to build the package from source,
you need to have the appropriate R development tools installed
([Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows, or
[these tools](https://mac.r-project.org/tools/) on Mac).

If you want the vignette to appear in your package when installing from
GitHub, use

``` r
# install.packages("devtools")
devtools::install_github("smeekes/bootUR", build_vignettes = TRUE, dependencies = TRUE)
```

instead. As building the vignette may take a bit of time (all bootstrap
code below is run), package installation will be slower this way.

After installation, the package can be loaded in the standard way:

``` r
library(bootUR)
```

## Functionality

A quick overview of the package functionality is provided in the
vignette `vignette("bootUR")`.

A further investigation of the functionalities is provided in the
*Journal of Statistical Software* article [bootUR: An R Package for
Bootstrap Unit Root Tests](https://doi.org/10.18637/jss.v106.i12).
2 changes: 1 addition & 1 deletion vignettes/bootUR-intro.Rmd → vignettes/bootUR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The development version of the `bootUR` package can be installed from GitHub usi
# install.packages("devtools")
devtools::install_github("smeekes/bootUR")
```
When installing from GitHub, in order to build the package from source, you need to have the appropriate R development tools installed (such as [Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows.)
When installing from GitHub, in order to build the package from source, you need to have the appropriate R development tools installed ([Rtools](https://cran.r-project.org/bin/windows/Rtools/) on Windows, or [these tools](https://mac.r-project.org/tools/) on Mac).

If you want the vignette to appear in your package when installing from GitHub, use
```{r install-vign, eval = FALSE}
Expand Down

0 comments on commit 610fa18

Please sign in to comment.