Skip to content

Commit

Permalink
docs: add docstring to TrueConsense.Outputs
Browse files Browse the repository at this point in the history
  • Loading branch information
florianzwagemaker authored and KHajji committed Apr 14, 2022
1 parent b52a750 commit 4855ee9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions TrueConsense/Outputs.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,21 @@


def WriteGFF(gffheader, gffdict, outdir, name):
"""Function takes a GFF header, a dictionary of GFF features, an output directory, and a name for
the output file, and writes the GFF header and the GFF features to a file in the output directory
Parameters
----------
gffheader
The header of the GFF file.
gffdict
a dictionary of GFF features
outdir
the directory where you want the output files to go
name
the name of the file you want to write
"""
with open(f"{outdir}/{name}.gff", "w") as out:
out.write(gffheader)

Expand Down

0 comments on commit 4855ee9

Please sign in to comment.