Skip to content

Commit

Permalink
Address CMD check doc complaints, update NAMESPACE and bump pkg version
Browse files Browse the repository at this point in the history
  • Loading branch information
anngvu committed Jul 3, 2023
1 parent 2998455 commit 76336a2
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: nfportalutils
Title: NF Portal Utilities
Version: 0.0.0.9210
Version: 0.0.0.9300
Authors@R: c(
person(given = "Robert", family = "Allaway", role = c("aut", "cre"),
email = "[email protected]",
Expand Down
5 changes: 5 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export(add_people_from_table)
export(add_publication_from_pubmed)
export(add_publication_from_unpaywall)
export(add_publications_from_file)
export(add_to_collection)
export(annotate_aligned_reads)
export(annotate_called_variants)
export(annotate_expression)
Expand Down Expand Up @@ -49,7 +50,10 @@ export(map_sample_io)
export(map_sample_output_rnaseq)
export(map_sample_output_sarek)
export(missing_annotation_email)
export(new_dataset)
export(new_project)
export(nf_sarek_datasets)
export(nf_star_salmon_datasets)
export(processing_flowchart)
export(qc_manifest)
export(register_study)
Expand All @@ -61,6 +65,7 @@ export(syn_login)
export(syncBP_maf)
export(table_query)
export(update_study_annotations)
export(use_latest_in_collection)
export(wiki_mod)
import(data.table)
import(reticulate)
Expand Down
5 changes: 3 additions & 2 deletions R/datasets.R
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ update_items <- function(current_coll, update_coll) {
#' Update an _existing_ collection so that all items or a subset of items reference their latest version.
#' This should work for both datasets (collection of files) and dataset collections (collection of datasets).
#'
#' @param collection_id
#' @param collection_id Collection id.
#' @param items Vector of dataset ids for which to update reference to latest version,
#' or "all" (default) to update all in the dataset collection.
#' @export
Expand Down Expand Up @@ -93,7 +93,7 @@ use_latest_in_collection <- function(collection_id, items = "all") {
#' Thus, while this is generic enough to handle both datasets and dataset collections
#' it is expected to be used more for dataset collections given that the dataset method is provided.
#'
#' @param collection_id Id of the collection.
#' @param collection_id Collection id.
#' @param items Character vector of one or more dataset entity ids to add.
#' @param check_items Whether to check that ids are really appropriate item types and remove non-appropriate item types
#' to help avoid Synapse errors (default `FALSE` because in most cases `items` are curated, and using check will be slower).
Expand Down Expand Up @@ -171,6 +171,7 @@ new_dataset <- function(name, parent, items, item_version = NULL, dry_run = TRUE
#'
#' @inheritParams new_dataset
#' @param output_map The `data.table` returned from `map_sample_output_sarek`. See details for alternatives.
#' @param workflow One of workflows used.
#' @param verbose Optional, whether to be verbose -- defaults to TRUE.
#' @import data.table
#' @return A list of dataset objects.
Expand Down
2 changes: 1 addition & 1 deletion man/add_to_collection.Rd

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

2 changes: 2 additions & 0 deletions man/nf_sarek_datasets.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/use_latest_in_collection.Rd

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

0 comments on commit 76336a2

Please sign in to comment.