Merge branch 'release/1.0' into production

Author: Kirill Müller

.Rbuildignore

@@ -2,12 +2,11 @@
 ^\.Rproj\.user$
 ^\.gitignore$
 ^README\.md$
-^NEWS\.md$
-^NEWS\.md\.tmpl$
 ^Makefile$
 ^Makefile\.in$
 ^makeR
 ^wercker\.yml$
 ^readme$
 ^appveyor\.yml$
 ^makeR$
+^cran-comments\.md$

.gitignore

@@ -4,3 +4,4 @@
 inst/doc
 /inst/web
 /vignettes/*.html
+/man

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rprojroot
 Title: Finding Files in Project Subdirectories
-Version: 0.2
+Version: 1.0
 Authors@R: person(given = "Kirill", family = "Müller", role = c("aut",
         "cre"), email = "krlmlr+r@mailbox.org")
 Description: Robust, reliable and flexible paths to files below a
@@ -29,3 +29,4 @@ Collate:
     'has-file.R'
     'root.R'
     'shortcut.R'
+    'zzz-autoroxy.R'

NAMESPACE

@@ -18,3 +18,4 @@ export(is.root_criterion)
 export(is_r_package)
 export(is_rstudio_project)
 export(root_criterion)
+importFrom(utils,str)

NEWS.md

@@ -1,30 +1,24 @@
-# rprojroot 0.2 (2016-03-24)
+# rprojroot 1.0 (2016-03-24)
 
-- Add TL;DR section to vignette.
-- Root criteria now have two function members, `find_file()` and `make_fix_file()`, instead of the now removed `make_find_root_file()` and `make_fix_root_file()`.
-
-
-Version 0.1 (2016-02-03)
-===
-
-Initial GitHub release.
-
-- Getting started:
-    - `find_package_root_file()`
-    - `find_rstudio_root_file()`
+Initial CRAN release.
 
 - S3 class `root_criterion`:
+    - Member functions: `find_file()` and `make_fix_file()`
     - `root_criterion()`
     - `as.root_criterion()`
     - `is.root_criterion()`
     - `has_file()`
     - `has_file_pattern()`
-    - `criteria`
+    - Built-in criteria:
         - `is_r_package`
         - `is_rstudio_project`
 
+- Getting started:
+    - `find_package_root_file()`
+    - `find_rstudio_root_file()`
+
 - Use a custom notion of a project root:
     - `find_root()`
     - `find_root_file()`
-    - `make_find_root_file()`
-    - `make_fix_root_file()`
+
+- Vignette

NEWS.md.tmpl

@@ -85,6 +85,7 @@ criteria <- structure(
   class = "root_criteria")
 
 #' @export
+#' @importFrom utils str
 str.root_criteria <- function(object, ...) {
   str(lapply(object, format))
 }

R/has-file.R

@@ -0,0 +1,21 @@
+# nolint start
+{
+    if (!"DESCRIPTION" %in% dir()) {
+        return(invisible(NULL))
+    }
+    if (file.exists("man")) {
+        return(invisible(NULL))
+    }
+    if (grepl("/.*[.]Rcheck/00_pkg_src/.*$", normalizePath(getwd(),
+        winslash = "/"))) {
+        stop("Cannot run this function in R CMD check.")
+    }
+    message("*** autoroxy: creating documentation")
+    if (!requireNamespace("roxygen2")) {
+        warning("Cannot load roxygen2. Package documentation will be unavailable.",
+            call. = FALSE)
+        return(invisible(NULL))
+    }
+    roxygen2::roxygenize(roclets = c("rd"))
+}
+# nolint end

R/zzz-autoroxy.R

@@ -1,6 +1,6 @@
 <!-- README.md is generated from README.Rmd. Please edit that file -->
-[rprojroot](https://krlmlr.github.io/rprojroot) [![wercker status](https://app.wercker.com/status/c4dfa136cd78514514e259cc388e880c/s/master "wercker status")](https://app.wercker.com/project/bykey/c4dfa136cd78514514e259cc388e880c) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/krlmlr/rprojroot?branch=master)](https://ci.appveyor.com/project/krlmlr/rprojroot) [![codecov.io](https://codecov.io/github/krlmlr/rprojroot/coverage.svg?branch=master)](https://codecov.io/github/krlmlr/rprojroot?branch=master) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rprojroot)](https://cran.r-project.org/package=rprojroot)
-=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
+[rprojroot](https://krlmlr.github.io/rprojroot) [![wercker status](https://app.wercker.com/status/c4dfa136cd78514514e259cc388e880c/s/master "wercker status")](https://app.wercker.com/project/bykey/c4dfa136cd78514514e259cc388e880c) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/krlmlr/rprojroot?branch=master&type=svg)](https://ci.appveyor.com/project/krlmlr/rprojroot) [![codecov.io](https://codecov.io/github/krlmlr/rprojroot/coverage.svg?branch=master)](https://codecov.io/github/krlmlr/rprojroot?branch=master) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rprojroot)](https://cran.r-project.org/package=rprojroot)
+======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
 
 This package helps accessing files relative to a *project root* to [stop the working directory insanity](https://gist.github.com/jennybc/362f52446fe1ebc4c49f).
 
@@ -19,11 +19,10 @@ How do we access the package root? In a robust fashion? Easily:
 ``` r
 dir(rprojroot::find_root("DESCRIPTION"))
 #>  [1] "appveyor.yml"    "DESCRIPTION"     "inst"           
-#>  [4] "Makefile"        "makeR"           "man"            
-#>  [7] "NAMESPACE"       "NEWS.md"         "NEWS.md.tmpl"   
-#> [10] "R"               "readme"          "README.md"      
-#> [13] "rprojroot.Rproj" "tests"           "vignettes"      
-#> [16] "wercker.yml"
+#>  [4] "Makefile"        "NAMESPACE"       "NEWS.md"        
+#>  [7] "NEWS.md.tmpl"    "R"               "readme"         
+#> [10] "README.md"       "rprojroot.Rproj" "tests"          
+#> [13] "vignettes"       "wercker.yml"
 ```
 
 Installation and further reading

README.md

@@ -0,0 +1,14 @@
+## Test environments
+* local Ubuntu install, R 3.2.4
+* ubuntu 12.04 (on travis-ci), R 3.2.4
+* win-builder (devel and release)
+
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
+
+## Reverse dependencies
+
+This is a new release, so there are no reverse dependencies.