Code Monkey home page Code Monkey logo

phenoplier_manuscript's Introduction

PhenoPLIER: Projecting genetic associations through gene expression patterns highlights disease etiology and drug mechanisms

HTML Manuscript PDF Manuscript GitHub Actions Status

Project description

PhenoPLIER is new computational strategy that integrates statistical associations from GWAS/TWAS with groups of genes (gene modules) that have similar expression patterns across the same cell types. This allows us to go beyond gene-trait statistical associations and infer the cell types where gene expression regulation is likely to be disrupted, resulting in cell type-specific pathology. Check out our manuscript in bioRxiv or our Manubot web version for more details. The Github repository with the source code for the analyses can be found here.

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:

  • content contains the manuscript source, which includes markdown files as well as inputs for citations and references. See USAGE.md for more information.
  • output contains the outputs (generated files) from Manubot including the resulting manuscripts. You should not edit these files manually, because they will get overwritten.
  • webpage is a directory meant to be rendered as a static webpage for viewing the HTML manuscript.
  • build contains commands and tools for building the manuscript.
  • ci contains files necessary for deployment via continuous integration.

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/greenelab/phenoplier_manuscript.

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:

  • *.sh
  • *.py
  • *.yml / *.yaml
  • *.json
  • *.bib
  • *.tsv
  • .gitignore

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

  • *.md
  • *.html
  • *.pdf
  • *.docx

Please open an issue for any question related to licensing.

phenoplier_manuscript's People

Contributors

adam3smith avatar adebali avatar agapow avatar agitter avatar cgreene avatar ctb avatar dhimmel avatar dsiddy avatar evancofer avatar gwaybio avatar lubianat avatar michaelmhoffman avatar miltondp avatar nfry321 avatar olgabot avatar petebachant avatar rgieseke avatar rhagenson avatar slochower avatar vincerubinetti avatar vsmalladi avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

phenoplier_manuscript's Issues

2023/08: Tasks and notes for resubmission

All files for this submission are in this shared folder: https://drive.google.com/drive/folders/1Zsv4ictaT6eT1_Rb1NuKMMZFb7yOhu4x?usp=drive_link

My comments below are prefixed with Milton's comment:

Before submitting

Quotes from the email they sent and my comments:

  • We require an additional point-by-point response to our editorial requests below. Please upload this using the file type ‘Related Manuscript File’ on our submission system, and do not modify or remove the previously uploaded cover letter or point-by-point response unless specifically asked.
    • Milton's comment: Responses are here (the document is in the shared folder).

Tasks

Crossed out text means the task is completed.

  1. We noticed that your manuscript was submitted in a ZIP file. Please note that all material used in the compilation of your manuscript should be included within the source code for your article. If you wish to use BibTeX for references, please copy the reference list from the .bbl file, paste it into the main manuscript .tex file, and delete the associated \bibliography and \bibliographystyle commands.

    • Your article should comprise of a single LaTex file which contains all of the relevant code used in the compilation and you should confirm this file converts to PDF on your system before being sent to us. Whilst not extensive, there is some additional information on LaTex formatting on this page here: https://www.nature.com/ncomms/submit/how-to-submit. With this in mind, resubmit your Article File as a single LaTex file which contains all the relevant information for your manuscript.

    • Alternatively, you can submit your Article File as a Word Doc.

    • Milton's comment: I uploaded a file named manuscript-main_text.tex.

  2. Please remove the author ORCIDs and social media handles (and logos) from the Article File.

  3. Please reformat your author list using this paper as an example: https://www.nature.com/articles/s41467-020-16621-x.pdf.

  4. Please make sure to include an address and country for each affiliation.

  5. Blair Sullivan, Dr. Benjamin Voight, and Dr. Carsten Skarke appear to be missing from the Author Contributions section. Please ensure that each author of the manuscript is included here.

  6. In the Author Contributions section, please use authors' initials instead of first initial and last names. For example, C.S.G., M.P., S.L., etc.

    • Milton's comment: There is a conflict with some author names, such as Carsten Skarke and Chun Su. I added this to the Response to Editorial requests document.
  7. Thank you for uploading the BioRender.com license to publish document. Please be sure to include this attribution line "Created with BioRender.com" in the Figure 1 legend for panel a.

  8. Please amend your references of "Supplementary File X" in the Article File to be "Supplementary Data X".

  9. Since you have included the eMERGE consortium in your Author Contributions -- "W. Wei, Q. Feng, B. Namjou, K. Kiryluk, I. Kullo, Y. Luo, and M.D. Ritchie, as part of the eMERGE consortium, provided critical feedback regarding the analyses of this data." -- please be sure to follow our consortia guidelines:

    For papers containing one or more consortia, all members of the consortium who contributed to the paper must be listed in the paper. If necessary, individual authors can be listed in both the main author list and as a member of a consortium listed at the end of the paper. When submitting your revised manuscript, the consortium name should be entered as an author, together with the contact details of a nominated consortium representative. See http://www.nature.com/authors/policies/authorship.html for our authorship policy and https://www.nature.com/documents/nr-consortia-formatting.pdf for further consortia formatting guidelines, which should be adhered to prior to acceptance.

  10. In Supplementary Figure 11, please remove the heading “Table 1”. We also encourage you to provide the primer sequences in a format that allows them to be extracted.

    • Milton's comment: I added Supplementary Data 8 with the primer sequences in readable format.
  11. Tables (Table 1) must have a short title that summarises the whole table. Further details can be included as footnotes to the table.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.