addPackageListingGithub {miniCRAN}R Documentation

Add DESCRIPTION information from package on github.

Description

Downloads the DESCRIPTION file from a package on github, parses the fields and adds (or replaces) a row in the available package database.

Usage

addPackageListingGithub(pdb = pkgAvail(), repo, username = NULL,
  branch = "master")

Arguments

pdb

Package database, usually the result of pkgAvail() or available.packages()

repo

Character vector. Name of repository on github, e.g. "RevolutionAnalytics/checkpoint"

username

Optional character vector. Name of repository on github, e.g. '"RevolutionAnalytics/checkpoint"“

branch

name of branch, defaults to "master"

Examples

# Create package database
pdb <- cranJuly2014

## Not run: 
  pdb <- pkgAvail(repos = c(CRAN = getOption("minicran.mran")))

  # Overwrite pdb with development version of miniCRAN at github
  newpdb <- addPackageListingGithub(pdb = pdb, "andrie/miniCRAN")
  newpdb["miniCRAN", ]

  # Add package from github that's not currently on CRAN
  newpdb <- addPackageListingGithub(pdb = pdb, repo = "RevolutionAnalytics/checkpoint")
  newpdb["checkpoint", ]

  set.seed(1)
  plot(makeDepGraph("checkpoint", availPkgs = newpdb, suggests = TRUE))

## End(Not run)

[Package miniCRAN version 0.2.10 Index]