Skip to content

Commit 54d1b4e

Browse files
committed
📖 DOC: update
1 parent e9b21c8 commit 54d1b4e

36 files changed

+177
-145
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: UCSCXenaTools
22
Title: Download and Explore Datasets from UCSC Xena Data Hubs
3-
Version: 1.2.0
3+
Version: 1.2.0.9000
44
Authors@R: c(person("Shixiang", "Wang", email = "w_shixiang@163.com", role = c("aut", "cre"),
55
comment = c(ORCID = "0000-0001-9855-7357")),
66
person("Martin", "Morgan", role="aut"))

NAMESPACE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ export(samples)
2020
export(showTCGA)
2121
export(to_snake)
2222
export(xena_default_hosts)
23+
exportClasses(XenaHub)
2324
import(dplyr)
2425
import(methods)
2526
import(shiny)
@@ -28,6 +29,7 @@ importFrom(httr,POST)
2829
importFrom(httr,content)
2930
importFrom(httr,stop_for_status)
3031
importFrom(magrittr,"%>%")
32+
importFrom(methods,new)
3133
importFrom(readr,cols)
3234
importFrom(readr,read_tsv)
3335
importFrom(readr,read_tsv_chunked)

NEWS.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# UCSCXenaTools
1+
# v1.2.1
22

3-
## v1.2.0
3+
## Bug fixes
4+
5+
* fix API functions cannot be called from outside
6+
7+
## Minor changes
8+
9+
* export `XenaHub` Class
10+
11+
# v1.2.0
412

513
* reformat code files
614
* update `XenaData` & `XenaDataUpdate()` function to obtain more info
715
* add `jsonlite` as import package
816
* add metadata for all datasets into package `inst` dir
917

10-
## v1.1.1
18+
# v1.1.1
1119

1220
* update doc for APIs
1321
* modify description for package
1422

15-
## v1.1.0
23+
# v1.1.0
1624

1725
* this version will change many variable names or functions. Update and Read the [documentation](https://github.com/ShixiangWang/UCSCXenaTools) are highly recommended!
1826
* add API functions, this is inspired by [xenaPython](https://github.com/ucscXena/xenaPython) package
@@ -22,47 +30,47 @@
2230
* new `XenaData` contains much more information
2331
* improve internal code
2432

25-
## v1.0.1
33+
# v1.0.1
2634

2735
* fix some grammar errors in documentation
2836

29-
## v1.0.0
37+
# v1.0.0
3038

3139
* update README, documentation and vignette
3240
* fix some typo
3341
* new function: `XenaBrowse` - open the dataset link using web browser
3442
* open grel all parameters to `XenaFilter` function
3543

36-
## v0.2.7
44+
# v0.2.7
3745

3846
* fix bug #2
3947
* add pipe operator
4048
* add doc & docs
4149

42-
## v0.2.6
50+
# v0.2.6
4351

4452
* add new datahub [**ATACseq**](https://xenabrowser.net/datapages/?host=https%3A%2F%2Fatacseq.xenahubs.net&removeHub=https%3A%2F%2Fxena.treehouse.gi.ucsc.edu%3A443)
4553
* enhance preparing data to R: provide options to select subset of original file data (see #1)
4654

47-
## v0.2.5
55+
# v0.2.5
4856

4957
* add new datahub **PCAWG**
5058
* speed up `XenaFilter` function
5159

52-
## v0.2.4
60+
# v0.2.4
5361

5462
* add new function `getTCGAdata` to help user download TCGA data by projects and biological data type
5563

56-
## v0.2.3
64+
# v0.2.3
5765

5866
* add shiny app to show TCGA datasets information of Xena
5967
* add `downloadTCGA` function to help user quickly download TCGA datasets
6068

61-
## v0.2.2
69+
# v0.2.2
6270

6371
* fix question about using temp directory
6472

65-
## v0.2.1
73+
# v0.2.1
6674

6775
* Add two hosts: Treehouse and TCGA Pan-Cancer
6876

R/XenaHub-class.R

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
#FUN: Set Class & operate XenaHub object directly
22

3-
##' @title a S4 class to represent UCSC Xena Data Hubs
4-
##' @slot hosts hosts of data hubs
5-
##' @slot cohorts cohorts of data hubs
6-
##' @slot datasets datasets of data hubs
7-
##' @importFrom methods new
3+
##' Class XenaHub
4+
##' @description a S4 class to represent UCSC Xena Data Hubs
5+
##' @slot hosts hosts of data hubs
6+
##' @slot cohorts cohorts of data hubs
7+
##' @slot datasets datasets of data hubs
8+
##' @importFrom methods new
9+
##' @export
810
.XenaHub = setClass(
911
"XenaHub",
1012
representation = representation(

docs/CONDUCT.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/USCSXenaTools.html

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

docs/articles/index.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)