Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 1.64 KB

README.md

File metadata and controls

77 lines (60 loc) · 1.64 KB
Raw

rdesc-parser

Parse R package DESCRIPTION files

Examples

Parse DESCRIPTION stream

var rdesc = require('rdesc-parser');
stream = fs.createReadStream('DESCRIPTION');
rdesc(stream, function(err, d) {
  if (err) throw(err);
  console.log(d);
})
{
  Package: 'sysreqs',
  Title: 'Install SystemRequirements of Packages',
  Version: '1.0.0.9000',
  Author: 'Gabor Csardi',
  Maintainer: 'Gabor Csardi <[email protected]>',
  Description: 'Automatically download and install system requirements of R packages.',
  License: 'MIT + file LICENSE',
  LazyData: 'true',
  URL: 'https://github.com/r-hub/sysreqs',
  BugReports: 'https://github.com/r-hub/sysreqs/issues',
  RoxygenNote: '5.0.1.9000',
  Suggests: [ { package: 'testthat' } ],
  Imports: [ { package: 'debugme' }, { package: 'desc' }, { package: 'utils' } ]
}

Parse DESCRIPTION file

var rdesc = require('rdesc-parser');
rdesc.parse_desc_file('./DESCRIPTION', function(err, d) {
  if (err) throw(err);
  console.log(d);
})

Parse DESCRIPTION from a package stream

It supports .tar.gz, .tar and .zip files.

var rdesc = require('rdesc-parser');
stream = fs.createReadStream('./test/foobar_1.0.0.tar.gz');
rdesc.parse_stream(stream, function(err, d) {
  if (err) throw(err);
  console.log(d);
})

Parse DESCRIPTION from a package file

It supports .tar.gz, .tar and .zip files.

var rdesc = require('rdesc-parser');
rdesc.parse_file('./test/foobar_1.0.0.zip', function(err, d) {
  if (err) throw(err);
  console.log(d);
})

License

ISC @ R Consortium

This repo is part of the R-hub project, supported by the R Consortium.