Address pre-release checks (#12)

* Reduce suggests * Style. * Add NEWS.md * Add CRAN comments * Don't run long-running test that goes beyond CRAN's limit * Remove taxa to avoid warnings on non-ASCII characters.
forestgeo · Jan 8, 2019 · 3542c45 · 3542c45
1 parent 784f01c
commit 3542c45
Show file tree

Hide file tree

Showing 34 changed files with 681 additions and 326 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,3 +1,4 @@
+^cran-comments\.md$
 ^\.buildignore$
 ^README\.Rmd$
 ^docs$

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,6 @@
 Package: fgeo.x
-Title: Tiny ForestGEO Datasets For Examples
+Title: Access Small ForestGEO Datasets For Examples
 Version: 0.0.0.9000
-Depends: 
-    R (>= 3.2)
 Authors@R:
     c(person(given = "Mauro",
              family = "Lepore",
@@ -15,15 +13,20 @@ Authors@R:
       person(given = "CTFS-ForestGEO",
              role = c("cph", "fnd"),
              email = "[email protected]"))
-Description: Tiny ForestGEO datasets (from Luquillo, Puerto Rico) for examples.
+Description: Access small ForestGEO datasets (from Luquillo,
+    Puerto Rico) for examples.
 License: GPL-3
 URL: https://github.com/forestgeo/fgeo.x
 BugReports: https://github.com/forestgeo/fgeo.x/issues
+Depends: 
+    R (>= 3.2)
+Imports: 
+    utils
+Suggests: 
+    spelling,
+    testthat
 Encoding: UTF-8
+Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 6.1.1
-Suggests: 
-    testthat,
-    spelling
-Language: en-US
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,3 @@
+# fgeo.x (development version)
+
+* Prepare initial release.
diff --git a/R/data.R b/R/data.R
@@ -19,12 +19,9 @@
 #'
 #' str(tree6_3species)
 #'
-#' str(taxa, give.attr = FALSE)
-#'
 #' str(vft_4quad)
-#'
 #' @family datasets
 #' @name datasets
-#' @aliases elevation habitat stem5 stem6 taxa tree5 tree6 vft_4quad
+#' @aliases elevation habitat stem5 stem6 tree5 tree6 vft_4quad
 #'   tree6_3species
 NULL
diff --git a/R/download_data.R b/R/download_data.R
@@ -8,8 +8,10 @@
 #' @return A dataset.
 #'
 #' @examples
+#' \dontrun{
+#' # May take > 5s (i.e. longer than OK for submitting to CRAN)
 #' str(download_data("luquillo_stem6_random"))
-#'
+#' }
 #' @family datasets
 #' @export
 download_data <- function(.data) {

diff --git a/R/example_path.R b/R/example_path.R
@@ -1,13 +1,13 @@
-#' Path to directory containing example data.
+#' Get path to file or directory containing example data.
 #'
-#' @param path Path to a file (with extension) from inst/extdata/
+#' @param path Name of file or directory. If `NULL`, the example files and
+#'   directories will be listed.
 #'
 #' @return A string giving a path to an example.
 #'
 #' @examples
 #' example_path()
 #' str(read.csv(example_path("taxa.csv")))
-#'
 #' @family datasets
 #' @export
 example_path <- function(path = NULL) {

diff --git a/README.Rmd b/README.Rmd
@@ -48,8 +48,6 @@ str(tree5)
 str(stem5)
 
 str(vft_4quad)
-
-str(taxa)
 ```
 
 Some other datasets that install with __fgeo.x__:
@@ -68,7 +66,7 @@ Download data from [__fgeo.data__](https://forestgeo.github.io/fgeo.data/):
 str(download_data("luquillo_stem6_random"))
 ```
 
-[Get started with __fgeo__](https://forestgeo.github.io/fgeo/articles/fgeo.html)
+[Get started with __fgeo__](https://forestgeo.github.io/fgeo/)
 
 ## Information
 

diff --git a/README.md b/README.md
@@ -19,9 +19,6 @@ Install the development version of **fgeo.x** with:
 Or [install all **fgeo** packages in one
 step](https://forestgeo.github.io/fgeo/index.html#installation).
 
-For details on how to install packages from GitHub, see [this
-article](https://goo.gl/dQKEeg).
-
 ## Example
 
 ``` r
@@ -125,30 +122,6 @@ str(vft_4quad)
 #>  $ HighHOM         : int  1 1 1 1 1 1 1 1 1 1 ...
 #>  $ LargeStem       : chr  NA NA NA NA ...
 #>  $ Status          : chr  "alive" "alive" "alive" "broken below" ...
-
-str(taxa)
-#> Classes 'tbl_df', 'tbl' and 'data.frame':    163 obs. of  21 variables:
-#>  $ ViewID        : int  1 2 3 4 5 6 7 8 9 10 ...
-#>  $ SpeciesID     : int  56 57 58 59 60 61 62 63 64 65 ...
-#>  $ SubspeciesID  : chr  NA NA NA NA ...
-#>  $ Family        : chr  "Fabaceae" "Euphorbiaceae" "Euphorbiaceae" "Fabaceae-papilionoideae" ...
-#>  $ Mnemonic      : chr  "AESAME" "ALCFLO" "ALCLAT" "ANDINE" ...
-#>  $ Genus         : chr  "Aeschynomene" "Alchorneopsis" "Alchornea" "Andira" ...
-#>  $ SpeciesName   : chr  "americana" "floribunda" "latifolia" "inermis" ...
-#>  $ Rank          : chr  NA NA NA NA ...
-#>  $ Subspecies    : chr  NA NA NA NA ...
-#>  $ Authority     : chr  "(Poir.) Rudd" "(Benth.) Müll. Arg." "Sw." "(W. Wright) Kunth ex DC." ...
-#>  $ IDLevel       : chr  "species" "species" "species" "species" ...
-#>  $ subspMnemonic : chr  NA NA NA NA ...
-#>  $ subspAuthority: chr  NA NA NA NA ...
-#>  $ FieldFamily   : chr  "Fabaceae" "Euphorbiaceae" "Euphorbiaceae" "Fabaceae" ...
-#>  $ Lifeform      : chr  NA NA NA NA ...
-#>  $ Description   : chr  NA NA NA NA ...
-#>  $ wsg           : num  0.678 0.427 0.42 0.642 0.636 ...
-#>  $ wsglevel      : chr  "family" "species" "species" "species" ...
-#>  $ ListOfOldNames: chr  NA NA NA NA ...
-#>  $ Specimens     : chr  NA NA NA NA ...
-#>  $ Reference     : chr  NA NA NA NA ...
 ```
 
 Some other datasets that install with **fgeo.x**:
@@ -225,8 +198,7 @@ str(download_data("luquillo_stem6_random"))
 #>  $ date     : num  20564 20670 NA NA 20670 ...
 ```
 
-[Get started with
-**fgeo**](https://forestgeo.github.io/fgeo/articles/fgeo.html)
+[Get started with **fgeo**](https://forestgeo.github.io/fgeo/)
 
 ## Information
 

diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,15 @@
+## 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
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
+
+## Downstream dependencies
+
+There are currently no downstream dependencies for this package.
diff --git a/data-raw/data.R b/data-raw/data.R
@@ -52,8 +52,10 @@ use_data(vft_4quad, overwrite = TRUE)
 
 
 
-taxa <- as.tibble(fgeo.data::luquillo_taxa)
-use_data(taxa, overwrite = TRUE)
+# This data contains non-ASCII characters that rise warninngs on CRAN.
+# Instead use example_path("taxa.csv")
+# taxa <- as.tibble(fgeo.data::luquillo_taxa)
+# use_data(taxa, overwrite = TRUE)
 
 
 

diff --git a/data/taxa.rda b/data/taxa.rda
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
diff --git a/docs/SUPPORT.html b/docs/SUPPORT.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# fgeo.x (development version)

		* Prepare initial release.