Skip to contents

Display information on model fits

Source: R/fitinfo.R
fitinfo.Rd

Display model specification, assessment, and run statistics or display a model assessment or set model scores or comments.

Usage

fitinfo(rows = "all", cols = "normal", report = TRUE)

Arguments

rows

Selected rows in the fits database. Use one of

  • a vector of fitids

  • 'all' for all fits

  • a named list to filter fits. List items are <field in fdb> = <value>, where <value> is a regex for character fields, or an actual value (or vector of values) for logical or numeric fields.

cols

Selected columns to display. Use one of

  • brief (1)

  • normal (2)

  • long (3)

  • all (4)

  • report

  • 1, 2, 3, or 4 is a shortcut for the above column sets

  • A vector of column names to include

report

If TRUE, give a report (on a single fit); otherwise, list info on fits. If rows is a numeric scalar, report defaults to TRUE; otherwise FALSE

score

Set the subjective model score in the fits database. This may be numeric or character; it'll be treated as a character.

assess

Sets the assessment comment in the fits database.

map

Sets the map comment in the fits database.

sort

The name of the column to be used to sort the table

decreasing

If TRUE, sort in descending order

nrows

Number of rows to display in the table. Positive numbers display the first n rows, and negative numbers display the last n rows. Use nrows = NA to display all rows.

quiet

If TRUE, doesn't print anything, just returns values

timezone

Time zone for launch time; use NULL to leave times in native UTC

Value

The fit table or assessment, invisibly

Details

fitinfo works in three different modes:

  • fitinfo(rows = <selected rows>, cols = <selected columns>) displays a table of selected rows and columns

  • fitinfo(rows = <a single row>, cols = 'report') displays a report for the selected fit id, focusing on the model assessment (the same information in the fit log)

  • Any of

    fitinfo(rows = <a single row>, score = <fit score>)
fitinfo(rows = <a single row>, assess = 'an assessment comment')
fitinfo(rows = <a single row>, map = 'a map comment')

    sets the subjective model fit score, the assessment comment, or the map comment. Any of these may be combined in a single call.