Reference

Classes

Main classes provided by the package

MetaRepository
limer.SessionCache

Exceptions

Exception classes

meta_repository.MetadataNotAvailableError

Functions

Utility functions

create_plotlist(): Export all plots for a report by calling export_plot for each item in meta_list.
export.create_directories(): Create directories and copy required template files.
export.download_and_combine(): Download all survey data for the given survey IDs and combine into a single DataFrame.
export.export_data(): Run the report pipeline up to data download and plot metadata resolution.
export.get_data(): Get response data from LimeSurvey in long format.
export.get_directory(): Returns the main directory of the report results.
export.get_n(): Get the number of respondents for a survey.
export.get_sname(): Get school name based on school number.
export.match_meta_reports(): Match Meta Reports with Lime Survey Reports.
get_metadata(): Get meta data for a report template.
limer_SIDs(): Get metadata of surveys filtered by school number and UBB flag.
limer_call(): Make a call to the LimeSurvey API.
limer_connect(): Connect to LimeSurvey.
limer_list_surveys(): List surveys from LimeSurvey.
limer_n(): Get the number of completed responses of a LimeSurvey survey.
limer_release(): Release a LimeSurvey session key.
limer_responses(): Get LimeSurvey survey responses as a pandas DataFrame.
limer_sessionkey(): Get LimeSurvey API Session Key
plot.create_ggplot()
plot.export_plot(): Export a plot for the OES report.
plot.get_directory(): Returns the main directory of the report results.
plot.get_plotdata()
render_pdf.get_directory(): Returns the main directory of the report results.
run.clean_files(): Clean temporary files except specified types.
run.main()
run.print_config(): Print the effective configuration as JSON for easy reading.
utils.get_data(): Get response data from LimeSurvey in long format.

Constants

Module-level constants and data

export.DEFAULTS
limer.session_cache
run.DEFAULTS

Other

Additional exports

data