FactualSchemaResult-class: Class "FactualSchemaResult"

In factualR: thin wrapper for the Factual.com server API

Description

Encapsulates the result of the Factual.com "schema" API call, which describes a table's structure.

Objects from the Class

Objects of type FactualSchemaResult should not be created directly; instead, please invoke factualGetSchema.

Slots

url:

URL used to call the Factual.com API. Useful mainly for debugging.

tableID:

unique identifier for the Factual.com table you queried.

status:

request status as returned by Factual.com's API: one of "ok," "warn," or "error."

message:

blank if the Factual handled the request without a problem; otherwise, a description of the problem.

resultRows:

number of rows in this result.

tableRows:

number of total rows in the table.

results:

a data frame of the table returned by Factual.com.

name:

human-readable description of the table.

table.meta:

a data.frame of table metadata, such as the creator, total number of rows, and description.

fields:

a data.frame of the fields in this table. Each row describes one field's name, data type, and so on.

processingTime:

time required on Factual's end to process the request; returned by Factual.com in verbose mode.

runTime:

time (ms) required for round-trip call to Factual.com.

fetchedAt:

date/time the data was requested from Factual.com.

Author(s)

Ethan McCallum

See Also

factualGetSchema

factualR documentation built on May 2, 2019, 3:46 p.m.