Skip to content

Commit

Permalink
document: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
adrientaudiere committed Dec 12, 2023
1 parent 3a0cdfd commit 7f783a5
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
3 changes: 1 addition & 2 deletions MiscMetabar.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ StripTrailingWhitespace: Yes
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageBuildArgs: --resave-data
PackageCheckArgs: --as-cran
PackageCheckArgs: --as-cran
PackageRoxygenize: rd,collate,namespace

SpellingDictionary: en_US
20 changes: 10 additions & 10 deletions R/data.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@
"data_fungi_sp_known"

#' This tutorial explore the dataset from Tengeler et al. (2020) available in the `mia` package.
#' obtain using `mia::makePhyloseqFromTreeSE(Tengeler2020)`
#'
#' obtain using `mia::makePhyloseqFromTreeSE(Tengeler2020)`
#'
#' This is a phyloseq version of the Tengeler2020 dataset.
#'
#'
#' Tengeler2020 includes gut microbiota profiles of 27 persons with ADHD.
#' A standard bioinformatic and statistical analysis done to demonstrate that altered microbial
#' composition could be a driver of altered brain structure and function and concomitant changes
#' in the animals behavior. This was investigated by colonizing young, male,
#' A standard bioinformatic and statistical analysis done to demonstrate that altered microbial
#' composition could be a driver of altered brain structure and function and concomitant changes
#' in the animals behavior. This was investigated by colonizing young, male,
#' germ-free C57BL/6JOlaHsd mice with microbiota from individuals with and without ADHD.
#'
#' Tengeler, A.C., Dam, S.A., Wiesmann, M. et al. Gut microbiota from persons with
#' Tengeler, A.C., Dam, S.A., Wiesmann, M. et al. Gut microbiota from persons with
#' attention-deficit/hyperactivity disorder affects the brain in mice. Microbiome 8, 44 (2020).
#' https://microbiomejournal.biomedcentral.com/articles/10.1186/s40168-020-00816-x
#' @format
#' @format
#' A phyloseq object
#'
"Tengeler2020_pq"
#'
"Tengeler2020_pq"
3 changes: 2 additions & 1 deletion man/blast_to_phyloseq.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/count_seq.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/subsample_fastq.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file removed tests/testthat/Rplots.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion vignettes/MiscMetabar.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ vignette: >
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
message=FALSE
message = FALSE
)
```

Expand Down

0 comments on commit 7f783a5

Please sign in to comment.