forked from r-lib/usethis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
browse-this.Rd
55 lines (49 loc) · 1.65 KB
/
browse-this.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/browse.R
\name{browse-this}
\alias{browse-this}
\alias{browse_github}
\alias{browse_github_issues}
\alias{browse_github_pulls}
\alias{browse_travis}
\alias{browse_cran}
\title{Quickly browse to important package webpages}
\usage{
browse_github(package = NULL)
browse_github_issues(package = NULL, number = NULL)
browse_github_pulls(package = NULL, number = NULL)
browse_travis(package = NULL, ext = c("org", "com"))
browse_cran(package = NULL)
}
\arguments{
\item{package}{Name of package; leave as \code{NULL} to use current package}
\item{number}{For GitHub issues and pull requests. Can be a number or
\code{"new"}.}
\item{ext}{Version of travis to use.}
}
\description{
These functions take you to various webpages associated with a package and
return the target URL invisibly. Some URLs are formed from first principles
and there is no guarantee there will be content at the destination.
}
\details{
\itemize{
\item \code{browse_github()}: Looks for a GitHub URL in the URL field of
\code{DESCRIPTION}.
\item \code{browse_github_issues()}: Visits the GitHub Issues index or one specific
issue.
\item \code{browse_github_pulls()}: Visits the GitHub Pull Request index or one
specific pull request.
\item \code{browse_travis()}: Visits the package's page on \href{https://travis-ci.org}{Travis CI}.
\item \code{browse_cran()}: Visits the package on CRAN, via the canonical URL.
}
}
\examples{
browse_github("gh")
browse_github_issues("backports")
browse_github_issues("backports", 1)
browse_github_pulls("rprojroot")
browse_github_pulls("rprojroot", 3)
browse_travis("usethis")
browse_cran("MASS")
}