Execution of sk init –demo

sk init –demo is used below to execute a demo project with basic Scikick commands. This command is meant for interative usage by the reader, however, outputs are provided below for convenience.

Execution

sk init --demo

SCIKICK DEMO: A demo project will be used to demonstrate some features of scikick.

SCIKICK DEMO: ----------  Starting a New Project  ----------
SCIKICK DEMO: A new scikick project can be initialized with sk init which will:
SCIKICK DEMO: check some software dependencies,
SCIKICK DEMO: add the scikick.yml config file (-y),
SCIKICK DEMO: and make some useful directories (-d).
$ sk init -yd
sk: Checking scikick software dependencies
sk: Importing template analysis configuration file
sk: Writing to scikick.yml
sk: Created dir(s): report, input, output, code
SCIKICK DEMO: Demo project has been initialized.
SCIKICK DEMO: Run sk init --demo again to continue.

sk init --demo

SCIKICK DEMO: ----------  Adding Some Notebooks  -----------
SCIKICK DEMO: Documents can be added to the project with sk add.
SCIKICK DEMO: -d is used to specify which documents must run
SCIKICK DEMO: before or are used by the added notebook. 
$ sk add code/index.Rmd
sk: An index file code/index.Rmd has been added and will be used as the homepage
sk: Added code/index.Rmd
$ sk add code/generate.Rmd
sk: Added code/generate.Rmd
$ sk add code/PCA.Rmd -d code/generate.Rmd -d code/analysis_config.txt
sk: Added code/PCA.Rmd
sk: Added dependency code/generate.Rmd to code/PCA.Rmd
sk:   code/PCA.Rmd will be executed after any executions of code/generate.Rmd
sk: Added dependency code/analysis_config.txt to code/PCA.Rmd
sk:   code/PCA.Rmd will be executed after any modifications to code/analysis_config.txt
$ sk add code/PC_score_statistics.Rmd -d code/PCA.Rmd
sk: Added code/PC_score_statistics.Rmd
sk: Added dependency code/PCA.Rmd to code/PC_score_statistics.Rmd
sk:   code/PC_score_statistics.Rmd will be executed after any executions of code/PCA.Rmd
SCIKICK DEMO: Run sk init --demo again to continue.

sk init --demo

SCIKICK DEMO: ----------       Check Status       ----------
SCIKICK DEMO: sk status will show which notebooks require execution.
$ sk status
 m--    code/index.Rmd
 m--    code/generate.Rmd
 me-    code/PCA.Rmd
 me-    code/PC_score_statistics.Rmd
Scripts to execute: 4
HTMLs to compile ('---'): 4
SCIKICK DEMO: Run sk init --demo again to continue.

sk init --demo

SCIKICK DEMO: ----------     Execute Notebooks    ----------
SCIKICK DEMO: sk run will execute all tasks needed to generate the final website.
$ sk run
sk:  Creating site layout from scikick.yml
sk: Executing code in code/generate.Rmd, outputting to report/out_md/code/generate.md
sk: Executing code in code/PCA.Rmd, outputting to report/out_md/code/PCA.md
sk:  Adding project map to report/out_md/code/PCA.md as report/out_md/code/PCA_tmp.md
sk:   Converting report/out_md/code/PCA_tmp.md to report/out_html/code/PCA.html
sk: Executing code in code/PC_score_statistics.Rmd, outputting to report/out_md/code/PC_score_statistics.md
sk:  Adding project map to report/out_md/code/generate.md as report/out_md/code/generate_tmp.md
sk:   Converting report/out_md/code/generate_tmp.md to report/out_html/code/generate.html
sk:  Adding project map to report/out_md/code/PC_score_statistics.md as report/out_md/code/PC_score_statistics_tmp.md
sk:   Converting report/out_md/code/PC_score_statistics_tmp.md to report/out_html/code/PC_score_statistics.html
sk: Executing code in code/index.Rmd, outputting to report/out_md/index.md
sk:  Adding project map to report/out_md/index.md as report/out_md/index_tmp.md
sk:   Converting report/out_md/index_tmp.md to report/out_html/index.html
sk: Done, homepage is report/out_html/index.html
SCIKICK DEMO: The completed site is located at
SCIKICK DEMO: /Users/mcarlucci/development/scikickstuff/scikick/docs/scikick_documentation/sk_demo/report/out_html/
SCIKICK DEMO: The index.html homepage can be opened in any web-browser.

SCIKICK DEMO: ----------        What Next?        ----------
SCIKICK DEMO: This should be all you need to get started. After reviewing
SCIKICK DEMO: the resulting website you could do one of:
SCIKICK DEMO: 1. Run sk init --demo again to see more demonstrations.
SCIKICK DEMO: 2. Perform your own testing with this project.
SCIKICK DEMO: 3. Start managing your own notebooks with scikick!

Next (Project Map)

---