Skip to content

Cleaning up the README.md file #73

@magnuspalmblad

Description

@magnuspalmblad

Since @524D added a number of nice screenshots, closing this issue, the README file is a bit messy. I think we should remove Figure 2, since this is no longer an experimental feature, which is also captured by one of the screenshots.

Some things to consider:

  1. Should add a new section with some example data, including the small primate files, but maybe also some of the food samples we used for spectra2species?
  2. Should we cite where we got the bacterial data from that is currently used in the screenshots, and link to where it can be downloaded? I think this would be fair.
  3. Would it make sense to use the same datasets for all screenshots? Or the most appropriate for each, e.g. the fish, mammals and birds from the food authentication study for spectra2species, and @neely's Fusion Lumos with the higher charge states for the two data set comparison (heatmap)?
  4. Should we (medium-term) move the documentation in the README file to Read the Docs and only have a minimum README file?

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions