Skip to content

Commit 3c023fb

Browse files
committed
add pkgdown reference sections
1 parent e4d6dea commit 3c023fb

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ meta <- meta %>% left_join(host_info)
4949
#### Extract earliest year from 3 date columns
5050

5151
``` r
52-
meta <- meta %>% pdtools::get_earliest_year()
52+
earliest_year <- meta %>% pdtools:return_earliest_year()
53+
54+
meta <- meta %>% left_join(earliest_year)
5355
```
5456

5557
#### Generate ftp download paths for a collection of isolates
@@ -119,3 +121,6 @@ get_pangenome_representatives(pan_mat = pan_PA, SEED = 2, desired_coverage = .99
119121
- return a vector of new genomes that were not present in the old
120122
list.
121123
- also return genomes with newer assembly accession version
124+
- Download\_SNP\_trees
125+
- generate\_SNPtree\_urls
126+
- Reference README? <https://ftp.ncbi.nlm.nih.gov/pathogen/ReadMe.txt>

_pkgdown.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
url: ~
22

3+
reference:
4+
- title: Download helpers
5+
- contents:
6+
- list_PDGs
7+
- download_PDD_metadata
8+
- download_most_recent_complete
9+
- find_most_recent_complete
10+
- check_complete_PDG
11+
- make_fna_urls
12+
- make_SNPtree_urls
13+
- title: Metadata manipulations
14+
- contents:
15+
- extract_consensus_ag_species
16+
- return_earliest_year
17+
- title: Pangenome tools
18+
- contents:
19+
- build_ppanggolin_file_fastas
20+
- generate_genome_vector
21+
- generate_pangenome
22+
- pan_mat_to_gene_vec_tibble
23+
- get_pangenome_representatives

0 commit comments

Comments
 (0)