Package index • instarreport

The framework

The 18 reporting items, and how to get a blank set of them to fill in.

instar_items: The invertebrate welfare reporting framework
instar_template(): Return an empty items template for a study
instar_set(): Record what a study reports for one or more items
instar_na(): Mark items as not applicable

Completing a report

Three routes to the same items table: the INSTAR.csv sheet, an interactive prompt, or direct assignment in a script.

read_items(): Read items from a CSV file
write_template(): Write a blank CSV for authors to fill in
write_items(): Write a filled-in items table to an INSTAR CSV
instar_fill(): Interactively fill in the reporting items at the R console
instar_edit(): Edit a single item
print(<instar_items>): Print an items table, grouped by domain

Reports and figures

Turning completed items into a report object, and from there into the standardised one-page figure or a depositable sheet.

instar_report(): Build an invertebrate welfare report
print(<instar_report>): Print method for instar_report
summary(<instar_report>): Coverage summary for a report, as a data frame
plot(<instar_report>): Draw the standardised INSTAR figure
autoplot(<instar_report>): Return a report's figure as a plot object
save_figure(): Save a report's figure to disk
write_report(): Write a completed INSTAR report to CSV

Auditing many studies

Reading a corpus of deposited sheets, and summarising reporting coverage across a literature rather than a single study.

read_instar(): Read INSTAR sheets from disk
print(<instar_corpus>): Print an INSTAR corpus
summary(<instar_corpus>): Per-sheet summary of a corpus
`[`(<instar_corpus>): Subset a corpus
c(<instar_corpus>): Combine corpora
instar_audit(): Audit reporting coverage across many studies
audit_from_matrix(): Build an audit from a wide matrix of scores
print(<instar_audit>): Print an audit
summary(<instar_audit>): Summarise an audit
plot(<instar_audit>): Plot reporting coverage across a corpus
autoplot(<instar_audit>): Return an audit's figure as a plot object

Validation and the web tool

validate_items(): Validate user inputs to instar_report()
instar_app(): Launch the instarreport web tool

Package

instarreport instarreport-package: instarreport: an R implementation of the INSTAR framework