Update readme with GHA instructions and more detail #52
Conversation
README.md
Outdated
|
|
||
| ```bash | ||
| nextflow run AlexsLemonade/OpenScPCA-nf -profile batch | ||
| ``` | ||
|
|
||
| For most use cases you will want to specify an output directory other than the default using the `--results_bucket` argument. |
There was a problem hiding this comment.
What are most cases? When would you want to use the default bucket?
There was a problem hiding this comment.
The default bucket is currently the results release bucket. I expect some of this to change when we get to #44, but for now it is what it is. Writing this sentence was actually what led me to file #44; I expect to add a production profile that sets the output buckets and then lock them down a bit more to avoid accidental edits, with some kind of staging location the default, but we don't have all of that set up yet.
| For most use cases you will want to specify an output directory other than the default using the `--results_bucket` argument. | |
| For most use cases you will want to use the `--results_bucket` argument to avoid writing to the default output bucket. |
| ```bash | ||
| nextflow run AlexsLemonade/OpenScPCA-nf -profile batch --results_bucket {OUTDIR} | ||
| ``` | ||
|
|
||
| The workflow also has a couple of entry points other than the main workflow, for testing and creating simulated data. |
There was a problem hiding this comment.
I might make a new header for talking about entry points.
README.md
Outdated
| nextflow run AlexsLemonade/OpenScPCA-nf -profile batch -entry simulate --sim_pubdir {SIMDIR} | ||
| ``` | ||
|
|
||
| To run the workflow with simulated data, you can add the `simulated` profile. |
There was a problem hiding this comment.
This is different then running the simulated entry point right? I would explicitly state that/ make a new header.
There was a problem hiding this comment.
Yes, it is different. One generates the simulated data, the other uses it. I didn't like the overlap, but since one is an entry point and one is a profile, I thought it might be okay.
Co-authored-by: Ally Hawkins <[email protected]>
Co-authored-by: Ally Hawkins <[email protected]>
README.md
Outdated
|
|
||
| ```bash | ||
| nextflow run AlexsLemonade/OpenScPCA-nf -profile batch | ||
| ``` | ||
|
|
||
| For most use cases you will want to specify an output directory other than the default using the `--results_bucket` argument. |
There was a problem hiding this comment.
The default bucket is currently the results release bucket. I expect some of this to change when we get to #44, but for now it is what it is. Writing this sentence was actually what led me to file #44; I expect to add a production profile that sets the output buckets and then lock them down a bit more to avoid accidental edits, with some kind of staging location the default, but we don't have all of that set up yet.
| For most use cases you will want to specify an output directory other than the default using the `--results_bucket` argument. | |
| For most use cases you will want to use the `--results_bucket` argument to avoid writing to the default output bucket. |
README.md
Outdated
| nextflow run AlexsLemonade/OpenScPCA-nf -profile batch -entry simulate --sim_pubdir {SIMDIR} | ||
| ``` | ||
|
|
||
| To run the workflow with simulated data, you can add the `simulated` profile. |
There was a problem hiding this comment.
Yes, it is different. One generates the simulated data, the other uses it. I didn't like the overlap, but since one is an entry point and one is a profile, I thought it might be okay.
Co-authored-by: Ally Hawkins <[email protected]>
Co-authored-by: Ally Hawkins <[email protected]>
Closes #32
This PR adds more detail about running the openscpca-nf workflow, including most notably the discussion of running via GHA.