Skip to content

Commit

Permalink
Add licensing restriction note
Browse files Browse the repository at this point in the history
  • Loading branch information
HDash committed Jul 29, 2024
1 parent 4e2f7e5 commit 200a807
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,14 @@ Please note that the peaks and alignments included are a very small subset
to demonstrate the package and run tests to maintain the integrity of the
package.

## Licensing Restrictions
MotifPeeker incorporates the MEME Suite, which is available free of charge for
educational, research, and non-profit purposes. Users intending to use
MotifPeeker for commercial purposes are required to purchase a license for the
MEME Suite.

For more details, please refer to the [MEME Suite Copyright Page](https://meme-suite.org/meme/doc/copyright.html).

## Contact

### [Neurogenomics Lab](https://www.neurogenomics.co.uk/inst/report/EpiCompare.html)
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ status](https://github.com/neurogenomics/MotifPeeker/workflows/rworkflows/badge.

**Authors:** ***Hiranyamaya (Hiru) Dash, Thomas Roberts, Nathan
Skene***
**Updated:** ***Jul-23-2024***
**Updated:** ***Jul-29-2024***

## Introduction

Expand All @@ -41,6 +41,7 @@ package outputs an HTML report consisting of three sections:
the closest known motifs in the JASPAR or the provided database.

<!-- If you use `MotifPeeker`, please cite: -->

<!-- > -->

## Installation
Expand Down Expand Up @@ -157,7 +158,9 @@ MotifPeeker(
These input parameters must be provided:

<details>

<summary>

<strong>Details</strong>
</summary>

Expand All @@ -183,7 +186,9 @@ These input parameters optional, but *recommended* to add more analyses,
or enhance them:

<details>

<summary>

<strong>Details</strong>
</summary>

Expand Down Expand Up @@ -241,7 +246,9 @@ To make computation faster, we highly recommend tuning the following
arguments:

<details>

<summary>

<strong>Details</strong>
</summary>

Expand Down Expand Up @@ -278,7 +285,9 @@ contains the following files:
`MotifPeeker` comes with several datasets bundled:

<details>

<summary>

<strong>Details</strong>
</summary>

Expand Down Expand Up @@ -314,6 +323,16 @@ subset (*chr10:65,654,529-74,841,155*) of the actual data. It only
serves as an example to demonstrate the package and run tests to
maintain the integrity of the package.

## Licensing Restrictions

MotifPeeker incorporates the MEME Suite, which is available free of
charge for educational, research, and non-profit purposes. Users
intending to use MotifPeeker for commercial purposes are required to
purchase a license for the MEME Suite.

For more details, please refer to the [MEME Suite Copyright
Page](https://meme-suite.org/meme/doc/copyright.html).

## Contact

### [Neurogenomics Lab](https://www.neurogenomics.co.uk/inst/report/EpiCompare.html)
Expand Down

0 comments on commit 200a807

Please sign in to comment.