Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
asistradition committed Oct 11, 2020
1 parent 7e4899e commit 71a75c0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* Added additional messaging
* Restructured internal memory usage to be more efficient
* Added constraint lists for TFs and genes

### Version 0.2.1

Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,23 @@ data that is compatible with the [inferelator](https://github.com/flatironinstit
--species {yeast,fly,mouse,human}
-b constraning_bed_file.bed
--cpu num_cores
--genes gene_list.txt
--tfs tf_list.txt
This requires a motif PWM database (`-m PATH`),
a genome to search (both sequence as a FASTA `-f PATH` and annotations `-g PATH`),
and an output prefix for several files (`-o PATH`).
In addition, default settings for a specific species can be set with (`--species`).
A BED file can be provided (`-b PATH`) based on some constraining experiment to restrict searching to specific genomic areas.
A BED file can be provided (`-b PATH`) based on some constraining experiment to restrict searching to
specific genomic areas.
This will use multiple cores to search for motifs and process the resulting data.
By default, all available processors will be used, but this can be overridden with `--cpu N`.
A list of genes (one per line in a text file) can be provided to `--genes`
and a list of tfs (one per line in a text file) can be provided to `--tfs`.
A network will be built for only these genes or TFs.

The output from this script is an unsigned connectivity matrix (0, 1) connecting genes on rows to regulators on columns.
In addition, this produces an unfiltered score matrix (0, ) connecting genes on rows to regulators on columns.

### Requirements

Expand Down

0 comments on commit 71a75c0

Please sign in to comment.