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

Move the data-prep docs over from higlass #70

Merged
merged 1 commit into from
Apr 24, 2019
Merged

Conversation

mccalluc
Copy link
Contributor

@mccalluc mccalluc commented Apr 19, 2019

Description

What was changed in this pull request?

  • Copy docs from higlass

Complements higlass/higlass#628 (deletion of same file in the higlass repo); Toward #66 ... but I'm not sure that a sphinx build is worth the effort. I think it would be good to reorganize this document, though. Currently, a single page, with these headings:

   Bed Files
   Bedpe-like Files
   BedGraph files
   bigWig files
   Chromosome Sizes
   Gene Annotation Tracks
   Hitile files
   Cooler files
   Multivec Files
   Epilogos Data (multivec)
   States Data (multivec)
   Other Data (multivec)

I would propose to split it up like this, with each getting its own page. It's dense currently, and my guess is that users come to this with one kind of data at a time, and would prefer a smaller page with just the data they need:

   Non-genomic raster data
   Genomic data
      Bed Files
      Bedpe-like Files
      BedGraph files
      bigWig files
      Chromosome Sizes
      Gene Annotation Tracks
      Hitile files
      Cooler files
      Multivec Files (Maybe multivec is a single page?)
         Epilogos Data (multivec)
         States Data (multivec)
         Other Data (multivec)

Checklist

  • Unit tests added or updated
  • Updated CHANGELOG.md

@pkerpedjiev
Copy link
Member

pkerpedjiev commented Apr 24, 2019

I would propose to split it up like this, with each getting its own page. It's dense currently, and my guess is that users come to this with one kind of data at a time, and would prefer a smaller page with just the data they need:

That's a good idea. This PR or another one? I'm going to approve this PR, if you want to include the reorganization, that's fine. If you want to squash and merge and create a new PR for the reorganization that's fine too.

@mccalluc
Copy link
Contributor Author

I'll go ahead and merge this now, so higlass/higlass#628 can also be merged, and probably have PR for the doc reorg later today. Thanks!

@mccalluc mccalluc merged commit d656384 into develop Apr 24, 2019
@mccalluc mccalluc deleted the mccalluc/move-docs branch April 24, 2019 14:10
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

Successfully merging this pull request may close these issues.

2 participants