Description Usage Arguments Details Value Examples
view_projects()
summarises projects in a table with the properties as
columns and a row for each project. view_project()
returns a list of all
properties for a single project. browse_project()
opens the web page for
the project in the default browser.
1 2 3 4 5 | view_projects(repo, user, team, org, state = "open", n_max = 1000, ...)
view_project(project, repo, user, team, org, ...)
browse_project(project, repo, user, team, org, ...)
|
repo |
(string, optional) The repository specified in the format:
|
user |
(string, optional) The login of the user. |
team |
(string or integer, optional) The team ID or name. |
org |
(string, optional) The name of the organization. |
state |
(string, optional) Indicates the state of the projects to
return. Can be either "open", "closed", or "all". Default: |
n_max |
(integer, optional) Maximum number to return. Default: |
... |
Parameters passed to |
project |
(integer or string) The number or name of the project. |
You can summarise all the projects associated with either a repository, user, team or organization, by supplying them as an input.
For more details see the GitHub API documentation:
https://docs.github.com/en/rest/reference/projects#list-repository-projects
https://docs.github.com/en/rest/reference/projects#list-user-projects
https://docs.github.com/en/rest/reference/projects#list-organization-projects
https://docs.github.com/en/rest/reference/teams#check-team-permissions-for-a-project
https://docs.github.com/en/rest/reference/projects#get-a-project
view_projects()
returns a tibble of project properties.
view_project()
returns a list of properties for a single project.
browse_project()
opens the default browser on the project's page and
returns the URL.
Project Properties:
id: The ID of the project.
number: The number of the project for the repository, user or organization.
name: The name given to the project.
body: The description given to the project.
state: Whether the project is "open" or "closed".
private: Whether the project is private (organization and team projects only).
org_permissions: The default permission for organization members (organization and team projects only).
team_permissions: The default permission for team members (team projects only).
creator: The user who created the project.
created_at: When it was created.
updated_at: When it was last updated.
html_url: The URL to view the project.
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 | ## Not run:
# View a repository's projects
view_projects("ChadGoymer/githapi")
# View a user's projects
view_projects(user = "ChadGoymer")
# View an organization's projects
view_projects(org = "HairyCoos")
# View a team's projects
view_projects(team = "HeadCoos", org = "HairyCoos")
# View closed projects
view_projects("ChadGoymer/githapi", state = "closed")
# View all projects
view_projects("ChadGoymer/githapi", state = "all")
# View a specific repository project
view_project("Prioritisation", repo = "ChadGoymer/githapi")
# View a specific user project
view_project("Test project", user = "ChadGoymer")
# View a specific organization project
view_project("Prioritisation", org = "HairyCoos")
# View a specific team project
view_project("Prioritisation", team = "HeadCoos", org = "HairyCoos")
# Browse a specific repository project
browse_project("Prioritisation", "ChadGoymer/githapi")
# Browse a specific user project
browse_project("Test project", user = "ChadGoymer")
# Browse a specific organization project
browse_project("Prioritisation", org = "HairyCoos")
# Browse a specific team project
browse_project("Prioritisation", team = "HeadCoos", org = "HairyCoos")
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.