Wiki pages for applications

Issue #37 new
Ville Rantanen created an issue

As discussed in a group meeting, we need example pipelines for different purposes.

The work is coordinated by Alejandra, but individual pipelines should be documented by users.

See the wiki!
https://bitbucket.org/anduril-dev/sequencing/wiki/Home

Guidelines for tutorials and application pipelines:

  • clear title description
  • clear introduction of what the pipeline is for
  • clear description of inputs required and what is the expected output
  • no internal paths
  • check that wiki syntax is correctly formatted (i.e. looks OK online)
  • hint at possible future steps/downstream analysis, and mention what previous steps are required, if pipelines for that exist already link to those
  • comment on your particular choice of parameters
  • avoid long StringInput components, link to a separate file if needed
  • check that there are no other pipelines doing the same, if they can be merged then do so, if you want to keep them separate address what are the differences with the other one.

Subtasks

Comments (2)

  1. Log in to comment