In docs/getting-started/accessing-resources/getting-access-to-data.md, we had previously recommended using the flags --release current when running either data or results download scripts in order to change the symlink back to the real data/results after downloading the test data.
We need to rethink this docs section, as originally commented:
I realized that the instructions for setting the release back to current are quite likely to cause trouble in their current form. We may need to file an issue to update the scripts as well, but we should definitely give more complete instructions that won't cause accidental downloads of everything.
I'm realizing this may behave badly with the current scripts, as it could result in unexpected downloads. We should probably add a --use-release option or something like that which only updates the symlink.
Alternatively, we could start by adding a warning that you would not want to run the scripts as shown here (which I think was why we did not have an example), but you should run it with a project, module, etc. that you already have to avoid re-downloading data.
Note also that because results are nested within releases, you only need to run one of these, not both. You say either above, but show both, which I think could be misinterpreted.
In
docs/getting-started/accessing-resources/getting-access-to-data.md, we had previously recommended using the flags--release currentwhen running either data or results download scripts in order to change the symlink back to the real data/results after downloading the test data.We need to rethink this docs section, as originally commented:
posted by @jashapiro in https://github.com/AlexsLemonade/OpenScPCA-analysis/pull/503#pullrequestreview-2118768051
_posted by @jashapiro https://github.com/AlexsLemonade/OpenScPCA-analysis/pull/503#discussion_r1640075565_