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

Added three tutorial sections to the Qiita documentation #3032

Merged
merged 12 commits into from
Sep 16, 2020

Conversation

mcmk3
Copy link
Contributor

@mcmk3 mcmk3 commented Sep 10, 2020

Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

… Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.
@codecov-commenter
Copy link

codecov-commenter commented Sep 10, 2020

Codecov Report

Merging #3032 into dev will increase coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #3032      +/-   ##
==========================================
+ Coverage   94.94%   95.03%   +0.09%     
==========================================
  Files          74       74              
  Lines       14263    14284      +21     
==========================================
+ Hits        13542    13575      +33     
+ Misses        721      709      -12     
Impacted Files Coverage Δ
qiita_db/test/test_commands.py 95.09% <0.00%> (-0.15%) ⬇️
qiita_db/logger.py 98.11% <0.00%> (-0.14%) ⬇️
qiita_db/test/test_archive.py 97.72% <0.00%> (-0.10%) ⬇️
qiita_db/test/test_ontology.py 97.72% <0.00%> (-0.10%) ⬇️
qiita_db/meta_util.py 88.62% <0.00%> (-0.08%) ⬇️
qiita_db/processing_job.py 73.84% <0.00%> (-0.08%) ⬇️
qiita_db/user.py 96.66% <0.00%> (-0.05%) ⬇️
qiita_db/handlers/artifact.py 97.43% <0.00%> (-0.04%) ⬇️
qiita_db/test/test_meta_util.py 99.15% <0.00%> (-0.03%) ⬇️
qiita_db/artifact.py 98.26% <0.00%> (-0.02%) ⬇️
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 68ffc5a...c1e5f69. Read the comment docs.

@mcmk3 mcmk3 marked this pull request as ready for review September 13, 2020 15:49
@mcmk3
Copy link
Contributor Author

mcmk3 commented Sep 13, 2020

I have made this pull request as part of a summer project with the Knight Lab.
It contains three new additions:

Within the redbiom section:

  • A section/tutorial on how to find and download public study data for own analysis using the Qiita plugin and command line versions of redbiom.
  • A section/tutorial on how to process data (using QIIME 2) downloaded using the command line version of redbiom to allow analysis of said data.

Within the Analyzing Samples section:

  • A section/tutorial on how to create the figures from Casals-Pascual et al 2020, and so justify experimental or clinical trial sample size, as an example of how public data, found using redbiom, can be useful.

(Other) Contributers:
@antgonza
Mehrbod Estaki

Copy link
Member

@antgonza antgonza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some reformat suggestions. Thank you!


-------------------------------------------------------------------------------

Statistical Analysis to Justify Clinical Trial Sample Size Tutorial
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It also will be nice to have a small intro about what we are gonna cover (basic download and data processing) + an intro to the two examples and links to jump to them.

Copy link
Contributor Author

@mcmk3 mcmk3 Sep 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback @antgonza .
In terms of links to the examples:
Currently the first section, which is the only one of the three to consider both examples is sub-divided by method (Qiita redbiom plugin vs. command line redbiom) rather than example.
I have written the introduction (see latest commit) to now reflect this, but am happy to reformat if you think this would be best.

Copy link
Member

@ElDeveloper ElDeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a few small comments!

@ElDeveloper ElDeveloper merged commit c68d7e5 into qiita-spots:dev Sep 16, 2020
@ElDeveloper
Copy link
Member

Thanks @mcmk3, @antgonza and @mestaki

antgonza added a commit that referenced this pull request Sep 16, 2020
* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
ElDeveloper added a commit that referenced this pull request Nov 9, 2020
* Version 092020 (#3034)

* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* fix #3036

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
ElDeveloper added a commit that referenced this pull request Nov 9, 2020
…3040)

* Version 092020 (#3034)

* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* adding job submit ENVIRONMENT and minor improvement to runWorkflow

* fix test

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
ElDeveloper added a commit that referenced this pull request Nov 9, 2020
* Version 092020 (#3034)

* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* fix #2920

* fix test

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
ElDeveloper added a commit that referenced this pull request Nov 10, 2020
* Version 092020 (#3034)

* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* rm create_qiime_mapping_file

* fixing some tests

* fixing more tests

* fix even more tests

* rm npt.assert_warns

* qiime-map -> sample-file

* update not_merged_samples.txt

* adding @ElDeveloper changes

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
ElDeveloper added a commit that referenced this pull request Nov 17, 2020
* Version 092020 (#3034)

* inject study_type in EBI and improvements to current automatic processing pipeline (#3023)

* inject study_type in ebi and improvements to current automatic proecssing pipeline

* addressing @ElDeveloper comments

* some general fixes/additions for next release (#3026)

* some general fixes/additions for next release

* adding test for not None job.release_validator_job

* fix #2839

* fix #2868 (#3028)

* fix #2868

* 2nd round

* fix errors

* more changes

* fix errors

* fix ProcessingJobTest

* fix PY_PATCH

* add missing TRN.add

* encapsulated_query -> perform_as_transaction

* fix #3022 (#3030)

* fix #3022

* adding tests

* fix #2320 (#3031)

* fix #2320

* adding prints to debug

* children -> 1

* APIArtifactHandlerTest -> APIArtifactHandlerTests

* configure_biom

* qdb.util.activate_or_update_plugins

* improving code

* almost there

* add values.template

* fix filepaths

* filepaths -> files

* fixing errors

* add prep.artifact insertion

* addressing @ElDeveloper comments

* fix artifact_definition active command

* != -> ==

* Added three tutorial sections to the Qiita documentation (#3032)

* Added three tutorial sections to the Qiita documentation: 'Retrieving Public Data for Own Analysis' and 'Processing public data retrieved with redbiom' to the redbiom tab, and 'Statistical Analysis to Justify Clinical Trial Sample Size Tutorial' to the analyzing samples tab.

* Update redbiom.rst

* Update redbiom.rst

* Update redbiom.rst

* Further updates to redbiom.rst and the Stats tutorial.

* update redbiom.rst

* Finished proof-reading

* Placed all three tutorials/sections together under Introduction to the download and analysis of public Qiita data

* added a new introduction, with links to the three sections

* Added figures to stats tutorial and contexts explanation

* Added figures to stats tutorial and contexts explanation

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Antonio Gonzalez <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* 092020 (#3033)

* 092020

* connect artifact with job

* rm INSERT qiita.artifact_processing_job

* Apply suggestions from code review [skip ci]

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

* adding qiita.study autoloaded column

* cleaning tests

* fix redbiom test

* avoiding clog submissions

* Apply suggestions from code review

Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>

Co-authored-by: Daniel McDonald <[email protected]>
Co-authored-by: Mirte Kuijpers <[email protected]>
Co-authored-by: Yoshiki Vázquez Baeza <[email protected]>
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.

4 participants