rbraries (version 0.2.0)

projects: Projects

Description

Projects

Usage

lio_project(platform, name, key = NULL, ...)
lio_project_dependencies(platform, name, version = "latest", key = NULL, ...)
lio_project_dependents(
  platform,
  name,
  page = 1,
  per_page = 30,
  key = NULL,
  ...
)
lio_project_dependent_repos(
  platform,
  name,
  page = 1,
  per_page = 30,
  key = NULL,
  ...
)
lio_project_contribs(platform, name, page = 1, per_page = 30, key = NULL, ...)
lio_project_sourcerank(platform, name, key = NULL, ...)
lio_project_search(
  q = NULL,
  sort = NULL,
  languages = NULL,
  licenses = NULL,
  keywords = NULL,
  platforms = NULL,
  page = 1,
  per_page = 30,
  key = NULL,
  ...
)

Arguments

platform

(character) a platform. required

name

(character) a project name. required

key

your Libraries.io API key. See Auth section in rbraries manual file. optional

...

curl options passed on to HttpClient

version

(character) a version string. optional

page

(integer) page to return. Default: 1

per_page

(integer) number of records to return per page. Maximum: 100. Default: 30

q

(character) a query string. optional

sort

(character) sort by one of rank, stars, dependents_count, dependent_repos_count, latest_release_published_at, contributions_count, or created_at. default: no sorting. optional

languages

(character) a language name. optional

licenses

(character) a license name. optional

keywords

(character) a keyword. optional

platforms

(character) a platform name. optional

Examples

# NOT RUN {
# project summary
lio_project('npm', 'grunt')

# dependencies
lio_project_dependencies('npm', 'grunt')
lio_project_dependencies('npm', 'grunt', '1.0.1')

# dependent repositories
lio_project_dependent_repos('npm', 'turf')

# project contributors
lio_project_contribs('npm', 'turf')

# source rank
lio_project_sourcerank('npm', 'turf')

# search
lio_project_search(q = 'grunt', per_page = 3)
# }