Skip to contents

Mirrors the morie cheatsheet CLI subcommand: a one-screen reference of install / learn / run / pull / ingest / help commands.

Usage

cheatsheet()

Value

Invisibly returns a character scalar of the cheatsheet. Called for its side effect of printing to the console.

Examples

cheatsheet()
#> morie cheat sheet
#> =================
#> 
#> Install
#>   curl -fsSL https://rootcoder007.github.io/morie/install.sh | bash
#>   brew tap rootcoder007/morie && brew install morie
#>   pip install morie
#>   install.packages('morie', repos = 'https://rootcoder007.r-universe.dev')
#>   docker run --rm ghcr.io/rootcoder007/morie:latest morie --help
#> 
#> Learn
#>   morie tutorial                  Interactive walkthrough
#>   morie cheatsheet                This card
#>   morie list-modules              List all 23 analysis modules
#>   morie list-datasets             List built-in datasets
#>   morie explain power_summary.csv What does this output mean?
#> 
#> Run
#>   morie run-module power-design --output-dir out/
#>   morie run-module descriptive-statistics --output-dir out/
#>   morie run-module frequentist-inference --output-dir out/
#>   morie run-modules all --output-dir out/
#> 
#> Pull
#>   morie pull tps-major --year 2024 --out tps-2024.csv
#>   morie pull tps-shootings --year 2024
#>   morie pull tps-homicide --year 2024
#>   morie pull tps-layers                                   # registry
#>   morie pull cpads --out cpads.csv                        # synth or real
#>   morie pull otis-a01-toy --out otis.csv                  # toy
#>   morie pull siu-toy --out siu.csv                        # toy SIU report
#> 
#> Ingest
#>   morie ingest tps --layer major-crime --year 2024 --out tps.csv
#>   morie ingest ckan --portal https://open.canada.ca/data --search alcohol
#>   morie ingest siu --report-id 22-OFD-001 --out report/
#> 
#> Help
#>   morie ask "I have a treatment-control design; what module fits?"
#>   morie doctor                    Check what's installed and working
#>   morie --help                    Top-level help
#> 
#> Refs
#>   Docs:     https://rootcoder007.github.io/morie/
#>   Issues:   https://github.com/rootcoder007/morie/issues
#>   PyPI:     https://pypi.org/project/morie/
#>   R:        https://rootcoder007.r-universe.dev/morie