Comments (16)
No, this is hopefully complete - if anything is unclear / missing in your opinion please comment here / ping core again π
from kmermaid.
Thank you both!!
from kmermaid.
MultiQC reports are nice of course π but no, they're not a requirement.
The link you posted is good, also take a look at https://nf-co.re/pipeline_health - it looks like you're missing the TEMPLATE
branch which is needed for synchronisation.
Though, arg, looks like you didn't start with the template π (in 33f9442). So you'll need to manually set up synchronisation - see https://nf-co.re/developers/sync
from kmermaid.
@olgabot perfect thanks!
from kmermaid.
@ewels yes this is our main problem! Thanks for the link!
from kmermaid.
Depending on how much you care about commit / contributor history, the easiest way to do this is to just make a new pipeline from scratch and then copy + paste your new code in as a second commit. You can then force push to wipe everything in this repo. Very, very blunt as it essentially deletes everything. But it's the quickest way to get stuff working π
The alternative of manual syncing isn't too bad otherwise, and you get a lot of experience in how to deal with resolving merge conflicts! Just be careful with reviewing the final solution to make sure that you didn't miss anything / make any mistakes, as it's pretty easy to do so..
from kmermaid.
that idea did cross my mind. I'll try manually adding first, thankfully I have git reflog
in case mistakes are made.
from kmermaid.
@phoenixAja if it's a total mess we should check with other contributors @pranathivemuri and @snafees if they're okay with blasting out the repo. I'm okay with it as it's relatively early and it's likely they'll have future changes as well. But if we want to preserve the previous ones then git reflog
and cherry-pick
it is!
from kmermaid.
Outstanding PRs aside, it seems like the kmermaid repo has only 2 contributors, me and Olga currently! Ideally i would like to have the contributions I made in my name, but if thatβs blocking a release, I wouldnβt mind if someone else copy pasted manually all the code. also, i think there is a number of places where czbiohub/nf-kmer-similarity exists instead of nf-core/kmermaid and the docker container iname should be changed/synced to this repo as well.
from kmermaid.
that's a different issue to fix @pranathivemuri so i wont tackle the docker stuff in this branch. I guess the commit history is already messed up with this repo (all of the ska
stuff i wrote got overwritten, so I'm no longer an author on this pipeline).
from kmermaid.
@ewels i have the .git
directory in addition to the following files, should i remove it before proceeding? It seems wrong to delete that, but it's not included in the list of dirs/files below. I just wanted to double check.
Untracked files:
(use "git add <file>..." to include in what will be committed)
.gitattributes
.github/
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
README.md
assets/
bin/
conf/
docs/
environment.yml
main.nf
nextflow.config
from kmermaid.
@phoenixAja ska stuff isn't merged into master yet. it is still in a PR as far as I can see - https://github.com/nf-core/kmermaid/pull/19/files
The only ska stuff added in the nf-core are right now the dependencies in environment.yml files. we should review and merge/make a decision on outstanding PRs before we merge.
from kmermaid.
still wierd that that got added to environment.yml
.. Also yes of course we are definitely planning on reviewing before any PR is approved.
from kmermaid.
@ewels i have the
.git
directory in addition to the following files, should i remove it before proceeding? It seems wrong to delete that, but it's not included in the list of dirs/files below. I just wanted to double check.Untracked files: (use "git add <file>..." to include in what will be committed) .gitattributes .github/ .gitignore .travis.yml CHANGELOG.md CODE_OF_CONDUCT.md Dockerfile LICENSE README.md assets/ bin/ conf/ docs/ environment.yml main.nf nextflow.config
definitely need to keep .git
..
from kmermaid.
If you take the nuclear option, you need to start in a totally fresh empty new directory. Then run nf-core create
. It will initialise a new git repository (including a new .git
directory) as part of that process. It will set up the required branches and make initial commits with the blank template.
Once that is complete, you can take your existing pipeline code and copy + paste it on top of the existing files (not including the .git
directory). You can then commit that. Git will do the difficult job of figuring out what you changed from the original template, facilitating synchronisation later on with new templates.
Once you've updated the new repo locally with your code, you can add a git remote for the existing GitHub repository and force push. If you do a regular push it will reject it as the histories are not compatible. If you do a force push then I think it will just wipe everything on GitHub and you'll have the two commits - one from the template and one with your pipeline. Make sure that you push all branches (git push --all
).
See the docs about creating a new template for details: https://nf-co.re/developers/adding_pipelines#create-a-pipeline-from-the-template
Maybe you already knew all this stuff? π Just wasn't quite sure what you had done to get to #29 (comment) though, so thought it worth describing.
from kmermaid.
closing this as 1.0.0 is released
from kmermaid.
Related Issues (20)
- Make cartesian product of molecule, ksize, sketchsize outside of "sourmash compute" command
- merge aligned and unaligned k-mer signatures from single cells HOT 3
- add a new release for kmermaid
- Add option to query newly created signatures with "sourmash search"
- Separate cell barcode counting and filtering
- Add option to remove hashes, e.g. ribosomal seqs HOT 2
- Update to sourmash 4.0
- KMERMAID: Convert all parameter docs to JSON schema HOT 1
- Add hash2kmer.py code to get potential genes and sequences for each k-mer hash
- TEMPLATE needs cleaning
- Pipeline has 2 releases, but default branch is dev
- Upgrade tqdm to 4.29.1 for tqdm.auto HOT 1
- BUG: `--peptide_fasta` is only for translation HOT 1
- Add sortMeRNA for removing ribosomal reads HOT 2
- Add option to skip compare HOT 3
- Add `sourmash index` option HOT 1
- Add --scaled option for sketches HOT 5
- No TEMPLATE branch HOT 3
- Add option to make per-cell bam files HOT 2
- tests take too long to run HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from kmermaid.