diff --git a/.Rbuildignore b/.Rbuildignore index 6f8a559..3a1233b 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,4 @@ +^cran-comments\.md$ ^tmp\.sh$ ^\.buildignore$ ^appveyor\.yml$ diff --git a/DESCRIPTION b/DESCRIPTION index 73a630a..4a25b25 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: fgeo Title: Analyze Forest Diversity and Dynamics -Version: 0.0.0.9002 +Version: 1.0.0 Authors@R: c(person(given = "Mauro", family = "Lepore", @@ -69,9 +69,11 @@ Authors@R: person(given = "CTFS-ForestGEO", role = c("cph", "fnd"), email = "ForestGEO@si.edu")) -Description: A tool to manipulate and visualize ForestGEO - datasets, and to analyze the abundance, demography, and habitats of - forest trees (). +Description: Install, load, and access the documentation of + multiple packages to analyze forest diversity and dynamics. 'fgeo' + allows you to manipulate and plot ForestGEO data, and to do common + analyses including abundance, demography, and species-habitats + associations (). License: GPL-3 URL: http://forestgeo.github.io/fgeo, https://github.com/forestgeo/fgeo diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..c7b6116 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,7 @@ +# fgeo (development version) + +* Prepare the first public release + +# fgeo 1.0.0 (internal GitHub release) + +* Internal GitHub release. diff --git a/README.Rmd b/README.Rmd index 0458107..bd51b5b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -40,7 +40,7 @@ manipulate <- "tool" datasets <- "x" ``` -__fgeo__ install and loads multiple R packages to analyze forest diversity and dynamics. It allows you to access, manipulate, and plot [ForestGEO](https://forestgeo.si.edu/) datasets, and to do common analyses including abundance, demography, and species-habitats associations. +__fgeo__ helps you to install, load, and access the documentation of multiple packages to analyze forest diversity and dynamics. It allows you to manipulate and plot [ForestGEO](http://www.forestgeo.si.edu/) data, and to do common analyses including abundance, demography, and species-habitats associations. * [Search functions and datasets](https://forestgeo.github.io/fgeo/articles/siteonly/reference.html) * [Try __fgeo__ online](https://bit.ly/fgeo-demo) @@ -55,23 +55,18 @@ __Expected R environment__ * No other R session is running * Current R session is clean (click _Session > Restart R_) -__Option 1: Install directly__ +Install the latest stable version of **fgeo** with: -```R +``` install.packages("devtools") -devtools::install_github("forestgeo/fgeo", upgrade = "never") +devtools::install_github("forestgeo/fgeo@*release") ``` -(If you reach GitHub's rate limit see [`usethis::browse_github_pat()`](https://usethis.r-lib.org/reference/browse_github_pat.html)). - -__Option 2: Install via [__fgeo.install__](https://github.com/forestgeo/fgeo.install#-fgeoinstall)__ +Or install the development version of **fgeo** with: ```R install.packages("devtools") -devtools::install_github("forestgeo/fgeo.install") - -# If needed, installs dependencies from CRAN and fgeo packages from GitHub -fgeo.install::install_fgeo() +devtools::install_github("forestgeo/fgeo", upgrade = "never") ``` --- @@ -79,9 +74,19 @@ fgeo.install::install_fgeo() * To upgrade packages see `?devtools::update_packages()` * To remove packages see `?remove.packages()` +
Tips to avoid or fix common installation problems +#### Alternative installation -
Tips to avoid or fix common installation problems +If you failed to install __fgeo__ try this instead: + +```R +install.packages("devtools") +devtools::install_github("forestgeo/fgeo.install") +fgeo.install::install_fgeo() +``` + +If this still fails, follow the advice below and then try to install __fgeo__ again. #### Update R, RStudio, and R packages @@ -109,6 +114,10 @@ Press Cmd/Ctrl + Shift + F10 to restart RStudio or go to _Session > Restart R_. #### Increase the rate limit to install from GitHub +If you reach GitHub's rate limit see [`usethis::browse_github_pat()`](https://usethis.r-lib.org/reference/browse_github_pat.html). + +If that was unclear continue reading. This describes the same process but in more detail. + * Ensure you have an account on GitHub (https://github.com/). * Generate a GitHub token named exactly `GITHUB_PAT` by running `usethis::browse_github_pat()` in R. * You will be sent to GitHub and you should see something like this: diff --git a/README.md b/README.md index 2fabcfc..f51cb65 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ status](https://codecov.io/gh/forestgeo/fgeo/branch/master/graph/badge.svg)](htt [![CRAN status](https://www.r-pkg.org/badges/version/fgeo)](https://cran.r-project.org/package=fgeo) -**fgeo** install and loads multiple R packages to analyze forest -diversity and dynamics. It allows you to access, manipulate, and plot -[ForestGEO](https://forestgeo.si.edu/) datasets, and to do common -analyses including abundance, demography, and species-habitats -associations. +**fgeo** helps you to install, load, and access the documentation of +multiple packages to analyze forest diversity and dynamics. It allows +you to manipulate and plot [ForestGEO](http://www.forestgeo.si.edu/) +data, and to do common analyses including abundance, demography, and +species-habitats associations. - [Search functions and datasets](https://forestgeo.github.io/fgeo/articles/siteonly/reference.html) @@ -32,25 +32,16 @@ associations. - No other R session is running - Current R session is clean (click *Session \> Restart R*) -**Option 1: Install directly** +Install the latest stable version of **fgeo** with: -``` r -install.packages("devtools") -devtools::install_github("forestgeo/fgeo", upgrade = "never") -``` - -(If you reach GitHub’s rate limit see -[`usethis::browse_github_pat()`](https://usethis.r-lib.org/reference/browse_github_pat.html)). + install.packages("devtools") + devtools::install_github("forestgeo/fgeo@*release") -**Option 2: Install via -[**fgeo.install**](https://github.com/forestgeo/fgeo.install#-fgeoinstall)** +Or install the development version of **fgeo** with: ``` r install.packages("devtools") -devtools::install_github("forestgeo/fgeo.install") - -# If needed, installs dependencies from CRAN and fgeo packages from GitHub -fgeo.install::install_fgeo() +devtools::install_github("forestgeo/fgeo", upgrade = "never") ``` ----- @@ -63,6 +54,20 @@ fgeo.install::install_fgeo() Tips to avoid or fix common installation problems +#### Alternative installation + +If you failed to install **fgeo** try this instead: + +``` r +install.packages("devtools") +devtools::install_github("forestgeo/fgeo.install") +fgeo.install::install_fgeo() +``` + +If this still fails, follow the advice below and then try to install +**fgeo** + again. + #### Update R, RStudio, and R packages - [How?](https://fgeo.netlify.com/2018/02/08/2018-02-08-update-r-rstudio-and-r-packages/) @@ -90,6 +95,12 @@ Restart R*. #### Increase the rate limit to install from GitHub +If you reach GitHub’s rate limit see +[`usethis::browse_github_pat()`](https://usethis.r-lib.org/reference/browse_github_pat.html). + +If that was unclear continue reading. This describes the same process +but in more detail. + - Ensure you have an account on GitHub (). - Generate a GitHub token named exactly `GITHUB_PAT` by running `usethis::browse_github_pat()` in R. @@ -146,8 +157,8 @@ Error : .onLoad failed in loadNamespace() for 'tcltk', details: ``` r library(fgeo) #> -- Attaching packages ----------------------------------------------- fgeo 0.0.0.9002 -- -#> v fgeo.analyze 0.0.0.9003 v fgeo.tool 0.0.0.9005 -#> v fgeo.plot 0.0.0.9402 v fgeo.x 1.0.0 +#> v fgeo.analyze 1.0.0 v fgeo.tool 1.0.0 +#> v fgeo.plot 1.0.0.9000 v fgeo.x 1.0.0.9000 #> -- Conflicts ------------------------------------------------------- fgeo_conflicts() -- #> x fgeo.tool::filter() masks stats::filter() ``` @@ -276,10 +287,10 @@ censuses (files <- path_file(names(censuses))) #> tree5.RData tree6.RData (folder <- tempdir()) -#> [1] "C:\\Users\\LeporeM\\AppData\\Local\\Temp\\1\\RtmpuuGjCq" +#> [1] "C:\\Users\\LeporeM\\AppData\\Local\\Temp\\1\\RtmpU3uA3r" (paths <- path(folder, files)) -#> C:/Users/LeporeM/AppData/Local/Temp/1/RtmpuuGjCq/tree5.RData -#> C:/Users/LeporeM/AppData/Local/Temp/1/RtmpuuGjCq/tree6.RData +#> C:/Users/LeporeM/AppData/Local/Temp/1/RtmpU3uA3r/tree5.RData +#> C:/Users/LeporeM/AppData/Local/Temp/1/RtmpU3uA3r/tree6.RData walk2(censuses, paths, ~ save(.x, file = .y)) diff --git a/_pkgdown.yml b/_pkgdown.yml index 762780e..23fbb7c 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -15,6 +15,14 @@ navbar: href: https://fgeocomm.shinyapps.io/transform-isolating/ - text: "Exploratory data analysis" href: articles/siteonly/eda.html + - text: News + menu: + - text: "Release notes" + - text: "Candidate 1.0.1" + href: articles/siteonly/fgeo-1-0-1-release-candidate.html + - text: "------------------" + - text: "Change log" + href: news/index.html right: - text: "Community" menu: diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..3fefb2a --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,17 @@ +## Test environments + +* local windows 10 x64, R 3.5.2 +* ubuntu 14.04 (on travis-ci), R 3.5.1 +* win-builder (devel and release) + +## R CMD check results + +WARNING +* New submission +* Unknown, possibly mis-spelled, fields in DESCRIPTION: 'Remotes' +* Strong dependencies not in mainstream repositories: + fgeo.analyze, fgeo.plot, fgeo.tool, fgeo.x + +## Downstream dependencies + +There are currently no downstream dependencies for this package. diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 01a6274..f2ae89d 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index bc11c58..808f000 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/ISSUE_TEMPLATE.html b/docs/ISSUE_TEMPLATE.html index 14f505b..ed35f27 100644 --- a/docs/ISSUE_TEMPLATE.html +++ b/docs/ISSUE_TEMPLATE.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 8626cc5..6c83a8a 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/SUPPORT.html b/docs/SUPPORT.html index 6e6ef9d..7faa66d 100644 --- a/docs/SUPPORT.html +++ b/docs/SUPPORT.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/articles/index.html b/docs/articles/index.html index fc310df..27f8948 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + @@ -156,7 +173,7 @@

All vignettes

diff --git a/docs/articles/siteonly/eda.html b/docs/articles/siteonly/eda.html index b39b79a..2c1e37c 100644 --- a/docs/articles/siteonly/eda.html +++ b/docs/articles/siteonly/eda.html @@ -30,7 +30,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -62,6 +62,23 @@ Exploratory data analysis + + + + @@ -159,9 +178,11 @@

fgeo: Analyze Forest Diversity and Dynamics

-

A tool to manipulate and visualize ForestGEO - datasets, and to analyze the abundance, demography, and habitats of - forest trees (<http://www.forestgeo.si.edu/>).

+

Install, load, and access the documentation of + multiple packages to analyze forest diversity and dynamics. 'fgeo' + allows you to manipulate and plot ForestGEO data, and to do common + analyses including abundance, demography, and species-habitats + associations (<http://www.forestgeo.si.edu/>).

diff --git a/docs/reference/fgeo_browse.html b/docs/reference/fgeo_browse.html index 07b944c..1a2fe38 100644 --- a/docs/reference/fgeo_browse.html +++ b/docs/reference/fgeo_browse.html @@ -63,7 +63,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -95,6 +95,23 @@ Exploratory data analysis + + diff --git a/docs/reference/fgeo_help.html b/docs/reference/fgeo_help.html index 3e0c303..916e78e 100644 --- a/docs/reference/fgeo_help.html +++ b/docs/reference/fgeo_help.html @@ -65,7 +65,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -97,6 +97,23 @@ Exploratory data analysis + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 150d050..898afc3 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -60,7 +60,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -92,6 +92,23 @@ Exploratory data analysis + + diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html index 946c665..639c226 100644 --- a/docs/reference/pipe.html +++ b/docs/reference/pipe.html @@ -63,7 +63,7 @@ fgeo - 0.0.0.9002 + 1.0.0.9000 @@ -95,6 +95,23 @@ Exploratory data analysis + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index a7b868a..c9223e5 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -19,7 +19,7 @@ https://forestgeo.github.io/fgeo//articles/siteonly/eda.html - https://forestgeo.github.io/fgeo//articles/siteonly/fgeo-1-0-0-release-candidate.html + https://forestgeo.github.io/fgeo//articles/siteonly/fgeo-1-0-1-release-candidate.html https://forestgeo.github.io/fgeo//articles/siteonly/questions-and-answers.html diff --git a/man/fgeo-package.Rd b/man/fgeo-package.Rd index 448191b..4456d0a 100644 --- a/man/fgeo-package.Rd +++ b/man/fgeo-package.Rd @@ -6,9 +6,11 @@ \alias{fgeo-package} \title{fgeo: Analyze Forest Diversity and Dynamics} \description{ -A tool to manipulate and visualize ForestGEO - datasets, and to analyze the abundance, demography, and habitats of - forest trees (). +Install, load, and access the documentation of + multiple packages to analyze forest diversity and dynamics. 'fgeo' + allows you to manipulate and plot ForestGEO data, and to do common + analyses including abundance, demography, and species-habitats + associations (). } \seealso{ Useful links: diff --git a/tests/spelling.R b/tests/spelling.R index 02e46f4..6713838 100644 --- a/tests/spelling.R +++ b/tests/spelling.R @@ -1,2 +1,3 @@ -if(requireNamespace('spelling', quietly=TRUE)) - spelling::spell_check_test(vignettes = TRUE, error = FALSE, skip_on_cran = TRUE) +if(requireNamespace('spelling', quietly = TRUE)) + spelling::spell_check_test(vignettes = TRUE, error = FALSE, + skip_on_cran = TRUE) diff --git a/vignettes/siteonly/fgeo-1-0-0-release-candidate.Rmd b/vignettes/siteonly/fgeo-1-0-1-release-candidate.Rmd similarity index 85% rename from vignettes/siteonly/fgeo-1-0-0-release-candidate.Rmd rename to vignettes/siteonly/fgeo-1-0-1-release-candidate.Rmd index 143be4b..0325b6c 100644 --- a/vignettes/siteonly/fgeo-1-0-0-release-candidate.Rmd +++ b/vignettes/siteonly/fgeo-1-0-1-release-candidate.Rmd @@ -1,7 +1,5 @@ --- -title: "fgeo 1.0.0 release candidate" -author: Mauro Lepore -date: "`r Sys.Date()`" +title: "fgeo 1.0.1 release candidate" output: rmarkdown::html_vignette editor_options: chunk_output_type: console @@ -20,9 +18,9 @@ knitr::opts_chunk$set( ) ``` -[__fgeo__](https://forestgeo.github.io/fgeo/index.html) is a collection of R packages to analyze forest diversity and dynamics. Its first release is planned for February 2019. Before that, we would love you to [give us some feedback, and report issues](https://github.com/forestgeo/fgeo/issues). +[__fgeo__](https://forestgeo.github.io/fgeo/index.html) is a collection of R packages to analyze forest diversity and dynamics. Its first public release is planned for early 2019. Before that, we would love you to [give us some feedback, and report issues](https://github.com/forestgeo/fgeo/issues). -This post highlights the major features. For more details please see the [Example](https://forestgeo.github.io/fgeo/index.html#example) and [Reference](https://forestgeo.github.io/fgeo/articles/siteonly/reference.html) sections. +This post highlights the main features. For more details please see the [Example](https://forestgeo.github.io/fgeo/index.html#example) and [Reference](https://forestgeo.github.io/fgeo/articles/siteonly/reference.html) sections. ### Explore fgeo