parseSupplement-methods: LegiScan Parser Methods - parseSupplement

Description Usage Arguments Value Note See Also Examples

Description

Generic method for parsing data retrieved from getSupplement API call

Method for parsing LegiScan API calls to getSupplement

Usage

1
2
3
4
5
6
7
parseSupplement(theSupplement)

## S4 method for signature 'XMLDocumentContent'
parseSupplement(theSupplement)

## S4 method for signature 'character'
parseSupplement(theSupplement)

Arguments

theSupplement

An object with the returned data from the supplement method

Value

A list object containing metadata and the MIME data retrieved by the API call

Note

The getSupplement API call method returns a binary MIME object with any of several document format types. Amendments and supplements are not supported in all states.

See Also

Other LegiScan API Parser Generics: parseAmendment, parseAmendment,XMLDocumentContent-method, parseAmendment,character-method; parseBillText, parseBillText,XMLDocumentContent-method, parseBillText,character-method; parseBill, parseBill,XMLDocumentContent,logical,character-method, parseBill,character,logical,character-method; parseMasterList, parseMasterList,XMLDocumentContent,logical,logical,numeric-method, parseMasterList,character,logical,logical,missing-method, parseSessions,character,logical,logical,missing-method; parseQuery, parseQuery,XMLDocumentContent-method, parseQuery,character-method; parseRollCall, parseRollCall,XMLDocumentContent,logical-method, parseRollCall,character,logical-method; parseSessions, parseSessions,XMLDocumentContent,logical-method, parseSessions,character,logical-method; parseSponsor, parseSponsor,XMLDocumentContent,logical-method, parseSponsor,character,logical-method; parseStates, parseStates,XMLDocumentContent,logical-method, parseStates,character,logical-method

Other LegiScan Parser Methods: parseAmendment, parseAmendment,XMLDocumentContent-method, parseAmendment,character-method; parseBillText, parseBillText,XMLDocumentContent-method, parseBillText,character-method; parseBill, parseBill,XMLDocumentContent,logical,character-method, parseBill,character,logical,character-method; parseMasterList, parseMasterList,XMLDocumentContent,logical,logical,numeric-method, parseMasterList,character,logical,logical,missing-method, parseSessions,character,logical,logical,missing-method; parseQuery, parseQuery,XMLDocumentContent-method, parseQuery,character-method; parseRollCall, parseRollCall,XMLDocumentContent,logical-method, parseRollCall,character,logical-method; parseSessions, parseSessions,XMLDocumentContent,logical-method, parseSessions,character,logical-method; parseSponsor, parseSponsor,XMLDocumentContent,logical-method, parseSponsor,character,logical-method; parseStates, parseStates,XMLDocumentContent,logical-method, parseStates,character,logical-method

Other LegiScan Parser Methods: parseAmendment, parseAmendment,XMLDocumentContent-method, parseAmendment,character-method; parseBillText, parseBillText,XMLDocumentContent-method, parseBillText,character-method; parseBill, parseBill,XMLDocumentContent,logical,character-method, parseBill,character,logical,character-method; parseMasterList, parseMasterList,XMLDocumentContent,logical,logical,numeric-method, parseMasterList,character,logical,logical,missing-method, parseSessions,character,logical,logical,missing-method; parseQuery, parseQuery,XMLDocumentContent-method, parseQuery,character-method; parseRollCall, parseRollCall,XMLDocumentContent,logical-method, parseRollCall,character,logical-method; parseSessions, parseSessions,XMLDocumentContent,logical-method, parseSessions,character,logical-method; parseSponsor, parseSponsor,XMLDocumentContent,logical-method, parseSponsor,character,logical-method; parseStates, parseStates,XMLDocumentContent,logical-method, parseStates,character,logical-method

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## Not run: 
# Create object of class LegiScan
myLegiScan <- legiscanR()

# Get the master list for Mississippi
theMasterList <- masterList(myLegiScan, "MS")

# Parse the XML/JSON formatted data into a data frame
cleanerMasterList <- parseMasterList(theMasterList)

# Get A bill (bill_id is in the 3rd Column of the master list)
aBill <- bill(myLegiScan, cleanerMasterList[1, 3])

# Parse the bill data
cleanerBill <- cleanBill(aBill, dataframe = FALSE, text = '')

# Retrieve the Supplement from the API call
aSupplement <- supplement(myLegiScan, cleanerBill[["supplements"]][["supplement_id"]])

# Parse the bill text response from LegiScan
cleanedSupplement <- parseSupplement(aSupplement)


## End(Not run)

wbuchanan/legiscanR documentation built on May 4, 2019, 2:01 a.m.