Skip to content

Commit 55c7297

Browse files
matthewphamiltonmatthewphamilton
committed
updated new module documentation tags
1 parent 5822bde commit 55c7297

3 files changed

Lines changed: 155 additions & 60 deletions

File tree

‎R/C4_Ready4Project.R‎

Lines changed: 79 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -3,67 +3,90 @@
33
#' A module of the ready4 framework that contains details of a modelling project.
44
#'
55
#' @include C4_Ready4Module.R
6-
#' @slot ds_tb Dataset (a tibble)
7-
#' @slot dictionary_r3 Dictionary (a ready4 submodule)
6+
#' @slot badges_url_1L_chr Badges URL (a character vector of length one)
7+
#' @slot dv_nm_1L_chr Dataverse name (a character vector of length one)
88
#' @slot dissemination_1L_chr Dissemination (a character vector of length one)
9+
#' @slot dv_root_1L_chr Dataverse root (a character vector of length one)
10+
#' @slot dv_server_1L_chr Dataverse server (a character vector of length one)
11+
#' @slot dv_toy_data_1L_chr Dataverse toy dataset name (a character vector of length one)
12+
#' @slot dvs_tb Dataverses (a tibble)
13+
#' @slot extensions_tb Extensions (a tibble)
14+
#' @slot filter_cdns_ls Filter conditions (a list)
15+
#' @slot gh_org_1L_chr Github organisation (a character vector of length one)
16+
#' @slot gh_repo_1L_chr Github repo (a character vector of length one)
17+
#' @slot gh_repos_brochure_chr Github brochure websites (a character vector)
18+
#' @slot gh_repos_exclude_chr Github repositories to exclude from GitHub organisation (a character vector)
19+
#' @slot gh_repos_framework_chr Github repositories from GitHub organisation that contain framework libraries (a character vector)
20+
#' @slot gh_repos_model_chr Github repositories from GitHub organisation that contain model libraries (a character vector)
21+
#' @slot gh_repos_programs_chr Github repositories from GitHub organisation that contain programs (a character vector)
22+
#' @slot gh_repos_subroutines_chr Github repositories from GitHub organisation that contain subroutines (a character vector)
23+
#' @slot gh_tag_1L_chr Github release tag (a character vector of length one)
24+
#' @slot gh_url_stub_1L_chr Github URL stub (a character vector of length one)
25+
#' @slot libraries_chr Library names (a character vector)
26+
#' @slot libraries_tb Library dataset (a tibble)
27+
#' @slot methods_tb Methods dataset (a tibble)
28+
#' @slot modules_tb Modules dataset (a tibble)
29+
#' @slot sections_chr Model section names (a character vector)
30+
#' @slot url_for_prj_1L_chr URL for project (a character vector of length one)
31+
#' @slot zenodo_1L_chr Zenodo repository (a character vector of length one)
32+
#' @slot dissemination_1L_chr Dissemination policy (a character vector of length one)
933
#' @name Ready4Project-class
1034
#' @rdname Ready4Project-class
1135
#' @export Ready4Project
1236
#' @exportClass Ready4Project
1337
Ready4Project <- setClass("Ready4Project",
1438
contains = "Ready4Module",
1539
slots = c(#additions_tb = "tbl_df",
16-
badges_url_1L_chr = "character",
17-
dv_nm_1L_chr = "character",
18-
dv_root_1L_chr = "character",
19-
dv_server_1L_chr = "character",
20-
dv_toy_data_1L_chr = "character",
21-
dvs_tb = "tbl_df",
22-
extensions_tb = "tbl_df",
23-
filter_cdns_ls = "list",
24-
gh_org_1L_chr = "character",
25-
gh_repo_1L_chr = "character",
26-
gh_repos_brochure_chr = "character",
27-
gh_repos_exclude_chr = "character",
28-
gh_repos_framework_chr ="character",
29-
gh_repos_model_chr = "character",
30-
gh_repos_programs_chr = "character",
31-
gh_repos_subroutines_chr = "character",
32-
gh_tag_1L_chr = "character",
33-
gh_url_stub_1L_chr = "character",
34-
libraries_chr = "character",
35-
libraries_tb = "tbl_df",
36-
methods_tb = "tbl_df",
37-
modules_tb = "tbl_df",
38-
sections_chr = "character",
39-
url_for_prj_1L_chr = "character",
40-
zenodo_1L_chr = "character",
41-
dissemination_1L_chr = "character"),
42-
prototype = list(#additions_tb = make_additions_tb(),
43-
badges_url_1L_chr = character(0),#project_badges_url_1L_chr = "https://img.shields.io/badge/ready4"
44-
dv_nm_1L_chr = character(0),#"ready4",
45-
dv_root_1L_chr = character(0),#"https://dataverse.harvard.edu/dataverse/",# root_1L_chr - print_data
46-
dv_server_1L_chr = "dataverse.harvard.edu", #server_1L_chr
47-
dv_toy_data_1L_chr = "fakes", #toy_data_dv_1L_chr =
48-
dvs_tb = NULL, # get_datasets_tb()[0,],#NULL,
49-
extensions_tb = NULL, # get_cls_extensions(get_libraries_tb())[0,],# cls_extensions_tb = get_cls_extensions(get_libraries_tb()) # NULL,
50-
filter_cdns_ls = list(),#NULL,
51-
gh_org_1L_chr = character(0), # org_1L_chr = "ready4-dev",
52-
gh_repo_1L_chr = character(0),#"ready4-dev/ready4",
53-
gh_repos_brochure_chr = character(0), # brochure_repos_chr =
54-
gh_repos_exclude_chr = character(0), #exclude_chr =
55-
gh_repos_framework_chr = character(0), # framework_repos_chr
56-
gh_repos_model_chr = character(0), # model_repos_chr
57-
gh_repos_programs_chr = character(0), # program_repos_chr
58-
gh_repos_subroutines_chr = character(0), # subroutine_repos_chr
59-
gh_tag_1L_chr = "Documentation_0.0",
60-
gh_url_stub_1L_chr = character(0), #url_stub_1L_chr = "https://ready4-dev.github.io/"
61-
libraries_chr = character(0), # module_pkgs_chr = make_modules_pkgs_chr() model_repos_chr = character(0),
62-
libraries_tb = NULL, # make_libraries_tb(), #get_libraries_tb() # pkg_extensions_tb = NULL
63-
#methods_chr = NULL, # print_methods - Can be derived from included Ready4Module
64-
methods_tb = NULL, # get_methods_tb(), #NULL, # print_methods
65-
modules_tb = NULL, # get_modules_tb()[0,], #### print_modules
66-
sections_chr = character(0),
67-
url_for_prj_1L_chr = character(0),
68-
zenodo_1L_chr = "ready4"
69-
))
40+
badges_url_1L_chr = "character",
41+
dv_nm_1L_chr = "character",
42+
dv_root_1L_chr = "character",
43+
dv_server_1L_chr = "character",
44+
dv_toy_data_1L_chr = "character",
45+
dvs_tb = "tbl_df",
46+
extensions_tb = "tbl_df",
47+
filter_cdns_ls = "list",
48+
gh_org_1L_chr = "character",
49+
gh_repo_1L_chr = "character",
50+
gh_repos_brochure_chr = "character",
51+
gh_repos_exclude_chr = "character",
52+
gh_repos_framework_chr ="character",
53+
gh_repos_model_chr = "character",
54+
gh_repos_programs_chr = "character",
55+
gh_repos_subroutines_chr = "character",
56+
gh_tag_1L_chr = "character",
57+
gh_url_stub_1L_chr = "character",
58+
libraries_chr = "character",
59+
libraries_tb = "tbl_df",
60+
methods_tb = "tbl_df",
61+
modules_tb = "tbl_df",
62+
sections_chr = "character",
63+
url_for_prj_1L_chr = "character",
64+
zenodo_1L_chr = "character",
65+
dissemination_1L_chr = "character"),
66+
prototype = list(#additions_tb = make_additions_tb(),
67+
badges_url_1L_chr = character(0),#project_badges_url_1L_chr = "https://img.shields.io/badge/ready4"
68+
dv_nm_1L_chr = character(0),#"ready4",
69+
dv_root_1L_chr = character(0),#"https://dataverse.harvard.edu/dataverse/",# root_1L_chr - print_data
70+
dv_server_1L_chr = "dataverse.harvard.edu", #server_1L_chr
71+
dv_toy_data_1L_chr = "fakes", #toy_data_dv_1L_chr =
72+
dvs_tb = tibble::tibble(), # get_datasets_tb()[0,],#NULL,
73+
extensions_tb = tibble::tibble(), # get_cls_extensions(get_libraries_tb())[0,],# cls_extensions_tb = get_cls_extensions(get_libraries_tb()) # NULL,
74+
filter_cdns_ls = list(),#NULL,
75+
gh_org_1L_chr = character(0), # org_1L_chr = "ready4-dev",
76+
gh_repo_1L_chr = character(0),#"ready4-dev/ready4",
77+
gh_repos_brochure_chr = character(0), # brochure_repos_chr =
78+
gh_repos_exclude_chr = character(0), #exclude_chr =
79+
gh_repos_framework_chr = character(0), # framework_repos_chr
80+
gh_repos_model_chr = character(0), # model_repos_chr
81+
gh_repos_programs_chr = character(0), # program_repos_chr
82+
gh_repos_subroutines_chr = character(0), # subroutine_repos_chr
83+
gh_tag_1L_chr = "Documentation_0.0",
84+
gh_url_stub_1L_chr = character(0), #url_stub_1L_chr = "https://ready4-dev.github.io/"
85+
libraries_chr = character(0), # module_pkgs_chr = make_modules_pkgs_chr() model_repos_chr = character(0),
86+
libraries_tb = tibble::tibble(), # make_libraries_tb(), #get_libraries_tb() # pkg_extensions_tb = NULL
87+
#methods_chr = NULL, # print_methods - Can be derived from included Ready4Module
88+
methods_tb = tibble::tibble(), # get_methods_tb(), #NULL, # print_methods
89+
modules_tb = tibble::tibble(), # get_modules_tb()[0,], #### print_modules
90+
url_for_prj_1L_chr = character(0),
91+
zenodo_1L_chr = "ready4"
92+
))

‎data-raw/clss/C4_Ready4Project.R‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,33 @@
33
#' A module of the ready4 framework that contains details of a modelling project.
44
#'
55
#' @include C4_Ready4Module.R
6-
#' @slot ds_tb Dataset (a tibble)
7-
#' @slot dictionary_r3 Dictionary (a ready4 submodule)
6+
#' @slot badges_url_1L_chr Badges URL (a character vector of length one)
7+
#' @slot dv_nm_1L_chr Dataverse name (a character vector of length one)
88
#' @slot dissemination_1L_chr Dissemination (a character vector of length one)
9+
#' @slot dv_root_1L_chr Dataverse root (a character vector of length one)
10+
#' @slot dv_server_1L_chr Dataverse server (a character vector of length one)
11+
#' @slot dv_toy_data_1L_chr Dataverse toy dataset name (a character vector of length one)
12+
#' @slot dvs_tb Dataverses (a tibble)
13+
#' @slot extensions_tb Extensions (a tibble)
14+
#' @slot filter_cdns_ls Filter conditions (a list)
15+
#' @slot gh_org_1L_chr Github organisation (a character vector of length one)
16+
#' @slot gh_repo_1L_chr Github repo (a character vector of length one)
17+
#' @slot gh_repos_brochure_chr Github brochure websites (a character vector)
18+
#' @slot gh_repos_exclude_chr Github repositories to exclude from GitHub organisation (a character vector)
19+
#' @slot gh_repos_framework_chr Github repositories from GitHub organisation that contain framework libraries (a character vector)
20+
#' @slot gh_repos_model_chr Github repositories from GitHub organisation that contain model libraries (a character vector)
21+
#' @slot gh_repos_programs_chr Github repositories from GitHub organisation that contain programs (a character vector)
22+
#' @slot gh_repos_subroutines_chr Github repositories from GitHub organisation that contain subroutines (a character vector)
23+
#' @slot gh_tag_1L_chr Github release tag (a character vector of length one)
24+
#' @slot gh_url_stub_1L_chr Github URL stub (a character vector of length one)
25+
#' @slot libraries_chr Library names (a character vector)
26+
#' @slot libraries_tb Library dataset (a tibble)
27+
#' @slot methods_tb Methods dataset (a tibble)
28+
#' @slot modules_tb Modules dataset (a tibble)
29+
#' @slot sections_chr Model section names (a character vector)
30+
#' @slot url_for_prj_1L_chr URL for project (a character vector of length one)
31+
#' @slot zenodo_1L_chr Zenodo repository (a character vector of length one)
32+
#' @slot dissemination_1L_chr Dissemination policy (a character vector of length one)
933
#' @name Ready4Project-class
1034
#' @rdname Ready4Project-class
1135
#' @export Ready4Project

‎man/Ready4Project-class.Rd‎

Lines changed: 50 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)