tutorials icon indicating copy to clipboard operation
tutorials copied to clipboard

Add a table of links to existing tutorials

Open daslu opened this issue 5 years ago • 4 comments

daslu avatar Mar 02 '19 13:03 daslu

I was thinking about some "metadata" we wanted to capture ideally in this table. I came up with this list of potential metadata.

  • Title
  • author
  • link to analysis code
  • link to "rendered" version, if applicable
  • link to "original" analysis, in case of a "copy of something existing to clojure".
  • link to dataset(s) used

Then I would like to capture "somehow"

  • descriptive vs predictive analysis
  • somehow some "subjects", not sure what that could be (things like ML, NLP, PCA, not sure what else)
  • which libraries have been used for different steps in the data science workflow such as
    • ingest data
    • clean data
    • model
    • visualize https://www.houseofbots.com/images/news/4603/cover.png

This should make the table an easier entry point, if you search for something

behrica avatar Mar 03 '19 14:03 behrica

Great plan @behrica !

Maybe add:

  • status (experimental / recommended)
  • reviewers (members who have reviewed the tutorial)
  • link to discussion (e.g. Zulip topic, github Issue)
  • version
  • changes log
  • free text comments

daslu avatar Mar 03 '19 16:03 daslu

If we keep the table in some comfortable data format (edn? csv?), then we can later serve it with some interactive, searchable format at the Scicloj website.

Say, something DataTables.

daslu avatar Mar 03 '19 16:03 daslu

+1 for edn

alanmarazzi avatar Jul 19 '19 09:07 alanmarazzi