Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

FR: Package-level documentation #13

jennybc opened this issue May 27, 2016 · 1 comment


None yet
2 participants
Copy link

commented May 27, 2016

I would love it if ?rprojroot worked 馃檪. I don't even care that much about what's there. Honestly this is just how I usually navigate to a package's index.

@krlmlr krlmlr closed this in 51a5c8e May 30, 2016


This comment has been minimized.

Copy link

commented May 30, 2016

I've added two links and a brief example, hope you won't need the index that much anymore.

krlmlr pushed a commit that referenced this issue May 30, 2016

Kirill M眉ller
Merge tag 'v1.0-4'
- Improve AppVeyor testing.
- Restore compatibility with R < 3.2.
- Add package documentation with a few examples (#13)

krlmlr added a commit that referenced this issue Nov 6, 2016

Merge tag 'v1.1'
- Compatibility
    - Compatible with R >= 3.0.0 with the help of the `backports` package.

- New root criteria
    - `is_remake_project` and `find_remake_root_file()` look for [remake]( project (#17).
    - `is_testthat` and `find_testthat_root_file()` that looks for `tests/testthat` root (#14).
    - `from_wd`, useful for creating accessors to a known path (#11).

- Minor enhancement
    - Criteria can be combined with the `|` operator (#15).

- Documentation
    - Add package documentation with a few examples (#13).
    - Clarify difference between `find_file()` and `make_fix_file()` in vignette (#9).
    - Remove unexported functions from documentation and examples (#10).
    - Use `pkgdown` to create website.

- Testing
    - Use Travis instead of wercker. Travis tests three R versions, and OS X.
    - Improve AppVeyor testing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.