Skip to content

Commit 96ab965

Browse files
committed
Documentation update
1 parent a742705 commit 96ab965

3 files changed

Lines changed: 17 additions & 19 deletions

File tree

DESCRIPTION

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@ Authors@R: c(person("Sean", "McGrath", role = c("aut", "cre"),
99
email = "cenhao.zhu@gmail.com"),
1010
person("Rui", "Duan", role = c("aut"),
1111
email = "rduan@hsph.harvard.edu"))
12-
Maintainer: Sean McGrath <sean_mcgrath@g.harvard.edu>
13-
Description: Implements methods to estimate a low rank matrix in an
14-
underrepresented target population from multi-source data. These methods
15-
leverage similarity in the latent row and column spaces between the source
16-
and target populations to improve estimation in the target population.
17-
The methods include the LatEnt spAce-based tRaNsfer lEaRning (LEARNER)
18-
method and the direct projection LEARNER (D-LEARNER) method described
19-
by McGrath et al. (2024) <doi:10.48550/arXiv.2412.20605>.
12+
Maintainer: Sean McGrath <sean.mcgrath514@gmail.com>
13+
Description: Implements transfer learning methods for low-rank matrix
14+
estimation. These methods leverage similarity in the latent row and column
15+
spaces between the source and target populations to improve estimation in
16+
the target population. The methods include the LatEnt spAce-based tRaNsfer
17+
lEaRning (LEARNER) method and the direct projection LEARNER (D-LEARNER)
18+
method described by McGrath et al. (2024) <doi:10.48550/arXiv.2412.20605>.
2019
License: GPL (>=3)
2120
Encoding: UTF-8
2221
LazyData: true

README.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ knitr::opts_chunk$set(
1919

2020
# learner
2121

22-
The `learner` package implements methods to estimate a low rank matrix in an underrepresented target population from multi-source data. These methods leverage similarity in the latent row and column spaces between the source and target populations to improve estimation in the target population. The methods include the LatEnt spAce-based tRaNsfer lEaRning (LEARNER) method and the direct projection LEARNER (D-LEARNER) method described by [McGrath et al. (2024)](https://doi.org/10.48550/arXiv.2412.20605).
22+
The `learner` package implements transfer learning methods for low-rank matrix estimation. These methods leverage similarity in the latent row and column spaces between the source and target populations to improve estimation in the target population. The methods include the LatEnt spAce-based tRaNsfer lEaRning (LEARNER) method and the direct projection LEARNER (D-LEARNER) method described by [McGrath et al. (2024)](https://doi.org/10.48550/arXiv.2412.20605).
2323

2424
## Installation
2525

@@ -37,7 +37,7 @@ We illustrate an example of how `learner` can be used. We first load the package
3737
library(learner)
3838
```
3939

40-
In this illustration, we will use one of the toy data sets in the package (`dat_highsim`) that has a high degree of similarity between the latent spaces of the source and target populations. The object `dat_highsim` is a list which contains the observed source population data matrix `Y_source` and the target population data matrix `Y_target`. As these data were simulated, the true values of the matrices are stored in `dat_highsim` (see `Theta_source` and `Theta_target`).
40+
In this illustration, we will use one of the toy data sets in the package (`dat_highsim`) that has a high degree of similarity between the latent spaces of the source and target populations. The object `dat_highsim` is a list which contains the observed source population data matrix `Y_source` and the target population data matrix `Y_target`. Since the data was simulated, the true values of the matrices are included in `dat_highsim` as `Theta_source` and `Theta_target`.
4141

4242
#### LEARNER Method
4343

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@ coverage](https://codecov.io/gh/stmcg/learner/graph/badge.svg)](https://app.code
99

1010
# learner
1111

12-
The `learner` package implements methods to estimate a low rank matrix
13-
in an underrepresented target population from multi-source data. These
14-
methods leverage similarity in the latent row and column spaces between
15-
the source and target populations to improve estimation in the target
16-
population. The methods include the LatEnt spAce-based tRaNsfer lEaRning
17-
(LEARNER) method and the direct projection LEARNER (D-LEARNER) method
18-
described by [McGrath et
12+
The `learner` package implements transfer learning methods for low-rank
13+
matrix estimation. These methods leverage similarity in the latent row
14+
and column spaces between the source and target populations to improve
15+
estimation in the target population. The methods include the LatEnt
16+
spAce-based tRaNsfer lEaRning (LEARNER) method and the direct projection
17+
LEARNER (D-LEARNER) method described by [McGrath et
1918
al. (2024)](https://doi.org/10.48550/arXiv.2412.20605).
2019

2120
## Installation
@@ -42,8 +41,8 @@ package (`dat_highsim`) that has a high degree of similarity between the
4241
latent spaces of the source and target populations. The object
4342
`dat_highsim` is a list which contains the observed source population
4443
data matrix `Y_source` and the target population data matrix `Y_target`.
45-
As these data were simulated, the true values of the matrices are stored
46-
in `dat_highsim` (see `Theta_source` and `Theta_target`).
44+
Since the data was simulated, the true values of the matrices are
45+
included in `dat_highsim` as `Theta_source` and `Theta_target`.
4746

4847
#### LEARNER Method
4948

0 commit comments

Comments
 (0)