Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README file to the download zip #277

Open
mikekucera opened this issue Mar 15, 2024 · 1 comment
Open

Add README file to the download zip #277

mikekucera opened this issue Mar 15, 2024 · 1 comment
Assignees

Comments

@mikekucera
Copy link
Contributor

mikekucera commented Mar 15, 2024

Description of new feature

Add a README file to the download zip.

The file could contain the following information:

  • The permalink for the network.
  • How to cite EnrichmentMap
  • Links to other resources like a FAQ.
  • A quick description of each file in the zip.
  • Instructions on how to load the data into EM-desktop.
  • The filter (cutoff) parameters used by the EM-service. (More advanced users ask to see this. Its also useful when loading into EM-desktop.)
  • Any warnings from the import step. For example if X number of ensembl genes could not be mapped we could say that.
  • Other useful information...
@mikekucera mikekucera self-assigned this Mar 28, 2024
@chrtannus
Copy link
Member

It looks good--sample:
README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants