@stdlib/datasets-sotu
v0.2.2
Published
State of the Union addresses by U.S. Presidents.
Downloads
1,635
Readme
State of the Union Addresses
State of the Union addresses given by U.S. Presidents.
The State of the Union address is an annual speech given by the President of the United States of America to a joint session of the United States Congress.
Installation
npm install @stdlib/datasets-sotu
Usage
var sotu = require( '@stdlib/datasets-sotu' );
sotu( [options] )
Returns State of the Union addresses.
var speeches = sotu();
// returns [{...},{...},...]
Each State of the Union address is represented by an object
with the following fields:
- year: speech year.
- name: President name.
- party: the President's political party.
- text: speech text.
The function accepts the following options
:
- name: a President's name or an
array
of names. - party: a political party or an
array
of political parties. - year: a year or an
array
of years. - range: two-element
array
specifying a year range.
To retrieve speeches by one or more Presidents, set the name
option.
var speeches = sotu({
'name': 'Barack Obama'
});
// returns [{...},{...},...]
speeches = sotu({
'name': [
'Franklin D Roosevelt',
'Barack Obama'
]
});
// returns [{...},{...},...]
To retrieve speeches from Presidents belonging to a particular political party, set the party
option.
var speeches = sotu({
'party': 'Democratic'
});
// returns [{...},{...},...]
speeches = sotu({
'party': [
'Federalist',
'Democratic'
]
});
// returns [{...},{...},...]
The following parties are recognized:
- Democratic
- Republican
- Democratic-Republican
- Federalist
- National Union
- Whig
- Whig & Democratic
- none
To retrieve speeches from one or more years, set the year
option.
var speeches = sotu({
'year': 2009
});
// returns [{...}]
speeches = sotu({
'year': [
1942,
2009
]
});
// returns [{...},{...}]
To specify a range of consecutive years, set the range
option, where the first element corresponds to the starting year and the second element corresponds to the final year.
var speeches = sotu({
'range': [ 2009, 2016 ]
});
// returns [{...},{...},...]
Notes
- The dataset includes the addresses given by newly inaugurated presidents to a joint session of Congress in Washington during their first year in office, even though these are technically not State of the Union addresses.
Examples
var sotu = require( '@stdlib/datasets-sotu' );
var speeches;
// Get a range of speeches:
speeches = sotu({
'range': [ 2009, 2013 ]
});
// returns [...]
// Get speeches by one or more Presidents:
speeches = sotu({
'name': [
'Abraham Lincoln',
'William J Clinton'
]
});
console.log( 'Number of addresses by Abraham Lincoln and Bill Clinton: %d', speeches.length );
// Get all addresses by Presidents belonging to the Democratic Party:
speeches = sotu({
'party': 'Democratic'
});
console.log( 'Number of addresses by Democrats: %d', speeches.length );
License
The data files (databases) are licensed under an Open Data Commons Public Domain Dedication & License 1.0 and their contents are licensed under a Creative Commons Zero v1.0 Universal. State of the Union addresses are works of the United States Government and thus have no copyright protection under United States copyright law. The software is licensed under Apache License, Version 2.0.
See Also
@stdlib/datasets-sotu-cli
: CLI package for use as a command-line utility.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
Copyright
Copyright © 2016-2024. The Stdlib Authors.