search

jessegmeyerlab / 2022-multi-omics-review

Other
0 stars 0 forks source link

readme

2022 Team Review: Mass Spectrometry-based Multi-Omics

HTML Manuscript PDF Manuscript GitHub Actions Status

view current web version of the review here

view current pdf version of the review here

Project information

Purpose. We are writing a collective review on multiomics!!! We are using Manubot to write this manuscript and track contributions. See the remaining readme below this section or at the link above for more information about manubot.

Authorship. I (Jesse Meyer) will be the senior author and I will decide author order for everyone based on the contributions recorded via github. We can consider co-first or co-second author depending on contributions. Our target Journal is Nature Methods.

Rules. See contributing for guidance on how to contribute and what is expected of authors. See also the code of conduct for participants.

Organizing and listing of papers can be done in the sections if they are still rough, but we prefer to add papers that should be covered as issues.

The focus of this review is to provide an overview of mass spectrometry based multi-omics. Each of us will have different focus sections and roles:

  1. Introduction
  2. sample preparation methods
  3. Data collection methods
  4. Data integration methods
  5. applications in model organisms (may discard)
  6. Clinical applications of multi-omics

Writing a review is easy if you break it down into parts!

  1. First do literature searches for papers relevant to the topic. Make lists of those papers with a few brief notes about each paper when you add it to the list.
  2. Organize the discovered papers into related groups
  3. Convert and extend notes into a paragraph describing each paper. Highly related papers can be grouped into the same paragraph.
    • Remember to use one topic sentence at the beginning of the paragraph that gives the focus of that paragraph.
  4. While we are writing and collecting papers, think about what key concepts need to be represented by figures, or what meta-analyses we could easily do to summarize the field. Sketch those figures freehand or in drawing software and we can commision a graphic designer finish them.

Manubot

Manubot is a system for writing scholarly manuscripts via GitHub. Manubot automates citations and references, versions manuscripts using git, and enables collaborative writing via GitHub. An overview manuscript presents the benefits of collaborative writing with Manubot and its unique features. The rootstock repository is a general purpose template for creating new Manubot instances, as detailed in SETUP.md. See USAGE.md for documentation how to write a manuscript.

Please open an issue for questions related to Manubot usage, bug reports, or general inquiries.

Repository directories & files

The directories are as follows:

Local execution

The easiest way to run Manubot is to use continuous integration to rebuild the manuscript when the content changes. If you want to build a Manubot manuscript locally, install the conda environment as described in build. Then, you can build the manuscript on POSIX systems by running the following commands from this root directory.

# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript, saving outputs to the output directory
bash build/build.sh

# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.

# Configure the webpage directory
manubot webpage

# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server

Sometimes it's helpful to monitor the content directory and automatically rebuild the manuscript when a change is detected. The following command, while running, will trigger both the build.sh script and manubot webpage command upon content changes:

bash build/autobuild.sh

Continuous Integration

Whenever a pull request is opened, CI (continuous integration) will test whether the changes break the build process to generate a formatted manuscript. The build process aims to detect common errors, such as invalid citations. If your pull request build fails, see the CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the main branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the gh-pages and output branches. The gh-pages branch uses GitHub Pages to host the following URLs:

For continuous integration configuration details, see .github/workflows/manubot.yaml.

License

License: CC BY 4.0 License: CC0 1.0

Except when noted otherwise, the entirety of this repository is licensed under a CC BY 4.0 License (LICENSE.md), which allows reuse with attribution. Please attribute by linking to https://github.com/jessegmeyerlab/2022-multi-omics-review.

Since CC BY is not ideal for code and data, certain repository components are also released under the CC0 1.0 public domain dedication (LICENSE-CC0.md). All files matched by the following glob patterns are dual licensed under CC BY 4.0 and CC0 1.0:

All other files are only available under CC BY 4.0, including:

Please open an issue for any question related to licensing.