Commit bb4b60f6 authored by David Trudgian's avatar David Trudgian

Update documentation, metadata

parent 82952aa8
......@@ -2,3 +2,9 @@
----------
Initial Version.
2016-05-17
----------
Version 0.0.3 for astrocyte release. Tested on astrocyte live.
Copyright © 2016. The University of Texas Southwestern Medical Center
5323 Harry Hines Boulevard Dallas, Texas, 75390 Telephone 214-648-3111
\ No newline at end of file
5323 Harry Hines Boulevard Dallas, Texas, 75390 Telephone 214-648-3111
# Minimal Workflow Package
# Example Wordcount Package
This is a minimal test workflow package that astrocyte tests can run against.
This is an example workflow package for astrocyte. It contains a worfklow
to count the occurences of each word in a text file.
## The Workflow
The workflow `workflow/main.nf` has three processes:
- Convert all the text in the input files to uppercase
- Split the text so each word is on a separate line
- Sort, find and count the occurence of unique words
## Parameters
There is a single parameter `story`. This provides 1 or more files that the
workflow should run on.
## Questions
If you have any questions about this workflow example, or Astrocyte in general,
please contact the BioHPC team via biohpc-help@utsouthwestern.edu
It does not require any cluster module software.
......@@ -7,16 +7,18 @@
# -----------------------------------------------------------------------------
# A unique identifier for the workflow package, text/underscores only
name: 'minimal_workflow_package'
name: 'example_wordcount'
# Who wrote this?
author: 'David Trudgian'
# A contact email address for questions
email: 'biohpc-help@utsouthwestern.edu'
# A more informative title for the workflow package
title: 'Minimal Test Workflow'
title: 'Example Wordcount Workflow'
# A summary of the workflow package in plain text
description: |
This is a minimal test workflow package that astrocyte tests can run against.
This is a minimal test workflow package that counts the occurences of words
in a test file. It can be used as a template to develop workflows, and as to
test the astrocyte platform.
# -----------------------------------------------------------------------------
# DOCUMENTATION
......
# Minimal Workflow Package
# Example Wordcount Package
This is a minimal test workflow package that astrocyte tests can run against.
This is an example workflow package for astrocyte. It contains a worfklow
to count the occurences of each word in a text file.
## The Workflow
The workflow `workflow/main.nf` has three processes:
- Convert all the text in the input files to uppercase
- Split the text so each word is on a separate line
- Sort, find and count the occurence of unique words
## Parameters
There is a single parameter `story`. This provides 1 or more files that the
workflow should run on.
## Questions
If you have any questions about this workflow example, or Astrocyte in general,
please contact the BioHPC team via biohpc-help@utsouthwestern.edu
It does not require any cluster module software.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment