Draft internal release (#140)

* Review description and readme * Update installation instructions. * Update news * Update version of release candidate * Update cran comments * Update site * Update candidate announcement
forestgeo · Jan 14, 2019 · a6a6712 · a6a6712
1 parent 1c11342
commit a6a6712
Show file tree

Hide file tree

Showing 38 changed files with 911 additions and 348 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,3 +1,4 @@
+^cran-comments\.md$
 ^tmp\.sh$
 ^\.buildignore$
 ^appveyor\.yml$

diff --git 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 (<http://www.forestgeo.si.edu/>).
+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 (<http://www.forestgeo.si.edu/>).
 License: GPL-3
 URL: http://forestgeo.github.io/fgeo,
     https://github.com/forestgeo/fgeo

diff --git a/NEWS.md 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
@@ -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,33 +55,38 @@ __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")
 ```
 
 ---
 
 * To upgrade packages see `?devtools::update_packages()`
 * To remove packages see `?remove.packages()`
 
+<details> <summary><strong>Tips to avoid or fix common installation problems</strong></summary>
 
+#### Alternative installation
 
-<details> <summary><strong>Tips to avoid or fix common installation problems</strong></summary>
+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
@@ -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()
 <summary><strong>Tips to avoid or fix common installation
 problems</strong></summary>
 
+#### 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 (<https://github.com/>).
   - 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
@@ -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
@@ -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
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
diff --git a/docs/ISSUE_TEMPLATE.html b/docs/ISSUE_TEMPLATE.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html