Skip to content

Commit

Permalink
update pkgdown build site and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
huizezhang-sherry committed Aug 6, 2022
1 parent 989718a commit fd13043
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 39 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Authors@R: c(
Description: Diagnostic plots for optimisation, with a focus on projection pursuit. These show paths the optimiser
takes in the high-dimensional space in multiple ways: by reducing the dimension using principal component analysis, and
also using the tour to show the path on the high-dimensional space. Several botanical colour palettes are included, reflecting the
name of the package. A paper describing the methodology can be found at https://journal.r-project.org/archive/2021/RJ-2021-105/index.html.
name of the package. A paper describing the methodology can be found at <https://journal.r-project.org/archive/2021/RJ-2021-105/index.html>.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Expand All @@ -32,7 +32,7 @@ Imports:
ggrepel,
ggforce,
tidyr
RoxygenNote: 7.1.2
RoxygenNote: 7.2.0
Depends:
R (>= 2.10)
Suggests:
Expand Down
3 changes: 1 addition & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@ knitr::opts_chunk$set(
# ferrn <a href='https://huizezhang-sherry.github.io/ferrn/'><img src='man/figures/logo.png' align="right" height="138.5" /></a>
<!-- badges: start -->
[![R build status](https://github.com/huizezhang-sherry/ferrn/workflows/R-CMD-check/badge.svg)](https://github.com/huizezhang-sherry/ferrn/actions)
[![Codecov test coverage](https://codecov.io/gh/huizezhang-sherry/ferrn/branch/master/graph/badge.svg)](https://codecov.io/gh/huizezhang-sherry/ferrn?branch=master)
<!-- badges: end -->

The **ferrn** package extracts key components in the data object collected by the guided tour optimisation, and produces diagnostic plots. An associated paper can be found at https://arxiv.org/abs/2104.03448.
The **ferrn** package extracts key components in the data object collected by the guided tour optimisation, and produces diagnostic plots. An associated paper can be found at <https://journal.r-project.org/archive/2021/RJ-2021-105/index.html>.

## Installation

Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@

[![R build
status](https://github.com/huizezhang-sherry/ferrn/workflows/R-CMD-check/badge.svg)](https://github.com/huizezhang-sherry/ferrn/actions)
[![Codecov test
coverage](https://codecov.io/gh/huizezhang-sherry/ferrn/branch/master/graph/badge.svg)](https://codecov.io/gh/huizezhang-sherry/ferrn?branch=master)
<!-- badges: end -->

The **ferrn** package extracts key components in the data object
collected by the guided tour optimisation, and produces diagnostic
plots. An associated paper can be found at
<https://arxiv.org/abs/2104.03448>.
<https://journal.r-project.org/archive/2021/RJ-2021-105/index.html>.

## Installation

Expand Down Expand Up @@ -100,7 +98,5 @@ bind_rows(holes_1d_geo, holes_1d_better) %>%
```

<p align="center">

<img src="man/figures/tour.gif">

</p>
9 changes: 3 additions & 6 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pandoc: '2.18'
pkgdown: 2.0.3
pkgdown_sha: ~
articles: {}
last_built: 2022-07-19T06:45Z
last_built: 2022-08-06T13:13Z
urls:
reference: https://huizezhang-sherry.github.io/ferrn/reference
article: https://huizezhang-sherry.github.io/ferrn/articles
Expand Down
18 changes: 6 additions & 12 deletions docs/reference/data.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/reference/ferrn-package.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified docs/reference/figures/README-pca-plot-1.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 modified docs/reference/figures/README-trace-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions man/data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/ferrn-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified man/figures/README-pca-plot-1.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 modified man/figures/README-trace-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fd13043

Please sign in to comment.